Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Nov 26, 2016
1 parent 47f02ff commit a61f7c0
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 15 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ make the life easier and will avoid wasting time on things which are not
requested. :sparkles:

## Discuss the changes before doing them
- First of all, open an issue in the repository, using the bug tracker ,
- First of all, open an issue in the repository, using the [bug tracker][1],
describing the contribution you would like to make, the bug you found or any
other ideas you have. This will help us to get you started on the right
foot.
Expand Down Expand Up @@ -59,4 +59,8 @@ Contributions are more than welcome!

Thanks! :sweat_smile:

[2]: https://github.com/IonicaBizau/code-style


[1]: https://github.com/IonicaBizau/bloggify-mongoose/issues

[2]: https://github.com/IonicaBizau/code-style
13 changes: 13 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Documentation

You can see below the API reference of this module.

### `init(config, bloggify, ready)`

#### Params
- **Object** `config`: The configuration object.
- `db` (String): The database url.
- `models` (Object): An object containing the Mongoose models.
- **Bloggify** `bloggify`: The `Bloggify` instance.
- **Function** `ready`: The ready handler.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016 Bloggify
Copyright (c) 2016 Ionică Bizău <[email protected]> (http://ionicabizau.net)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
47 changes: 35 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# bloggify-mongoose [![Version](https://img.shields.io/npm/v/bloggify-mongoose.svg)](https://www.npmjs.com/package/bloggify-mongoose) [![Downloads](https://img.shields.io/npm/dt/bloggify-mongoose.svg)](https://www.npmjs.com/package/bloggify-mongoose)

# bloggify-mongoose

[![Patreon](https://img.shields.io/badge/Support%20me%20on-Patreon-%23e6461a.svg)][patreon] [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![AMA](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/bloggify-mongoose.svg)](https://www.npmjs.com/package/bloggify-mongoose) [![Downloads](https://img.shields.io/npm/dt/bloggify-mongoose.svg)](https://www.npmjs.com/package/bloggify-mongoose) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

> Mustache renderer for Bloggify.
## Installation
## :cloud: Installation

```sh
$ npm i --save bloggify-mongoose
```

## Example

## :clipboard: Example



```js
// Configuration example
Expand Down Expand Up @@ -64,7 +70,8 @@ module.exports = {
};
```

## Documentation
## :memo: Documentation


### `init(config, bloggify, ready)`

Expand All @@ -75,17 +82,33 @@ module.exports = {
- **Bloggify** `bloggify`: The `Bloggify` instance.
- **Function** `ready`: The ready handler.

## How to contribute


## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].

## Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

## License
## :moneybag: Donations

Another way to support the development of my open-source modules is
to [set up a recurring donation, via Patreon][patreon]. :rocket:

[PayPal donations][paypal-donations] are appreciated too! Each dollar helps.

Thanks! :heart:


## :scroll: License

[MIT][license] © [Ionică Bizău][website]

[patreon]: https://www.patreon.com/ionicabizau
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
[donate-now]: http://i.imgur.com/6cMbHOC.png


[MIT][license] © [Bloggify][website]
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(http%3A%2F%2Fionicabizau.net)&year=2016#license-mit

[license]: http://showalicense.com/?fullname=Bloggify&year=2016#license-mit
[website]:
[website]: http://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[docs]: /DOCUMENTATION.md

0 comments on commit a61f7c0

Please sign in to comment.