Skip to content

Commit f1fa990

Browse files
committed
Updated docs
1 parent 6467c48 commit f1fa990

File tree

5 files changed

+115
-8
lines changed

5 files changed

+115
-8
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@
44
*.log
55
node_modules
66
*.env
7+
.DS_Store
8+
package-lock.json
9+
.bloggify/*

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016-17 Bloggify <support@bloggify.org> (https://bloggify.org)
3+
Copyright (c) 2016-20 Bloggify <support@bloggify.org> (https://bloggify.org)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 109 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,72 @@
11
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
22

3+
4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
17+
18+
19+
320
# bloggify-mongoose
421

522
[![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)
623

24+
25+
26+
27+
28+
29+
730
> Support for Mongoose models in Bloggify.
831
32+
33+
34+
35+
36+
37+
38+
39+
40+
41+
42+
43+
44+
45+
46+
47+
948
## :cloud: Installation
1049

1150
```sh
12-
$ npm i --save bloggify-mongoose
51+
# Using npm
52+
npm install --save bloggify-mongoose
53+
54+
# Using yarn
55+
yarn add bloggify-mongoose
1356
```
1457

1558

59+
60+
61+
62+
63+
64+
65+
66+
67+
68+
69+
1670
## :clipboard: Example
1771

1872

@@ -56,13 +110,25 @@ module.exports = {
56110

57111

58112

113+
114+
115+
116+
117+
118+
119+
120+
59121
## :question: Get Help
60122

61123
There are few ways to get help:
62124

125+
126+
63127
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
64128
2. For bug reports and feature requests, open issues. :bug:
65-
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
129+
130+
131+
66132

67133

68134
## :memo: Documentation
@@ -79,22 +145,60 @@ The model objects can be accessed by requiring the module or accessing the `Blog
79145

80146

81147

148+
149+
150+
151+
152+
153+
154+
155+
156+
157+
158+
82159
## :yum: How to contribute
83160
Have an idea? Found a bug? See [how to contribute][contributing].
84161

85162

163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
173+
174+
175+
176+
86177
## :dizzy: Where is this library used?
87178
If you are using this library in one of your projects, add it in this list. :sparkles:
88179

180+
- `todos-app-bloggify-react`
181+
182+
183+
184+
185+
186+
187+
188+
189+
89190

90-
- [`bloggify`](https://github.com/Bloggify/Bloggify) (by Bloggify)—We make publishing easy.
91-
- [`bloggify.org`](https://github.com/Bloggify/newww#readme) (by Bloggify)—The Bloggify.org website source code.
92191

93192
## :scroll: License
94193

95194
[MIT][license] © [Bloggify][website]
96195

97-
[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2016#license-mit
196+
197+
198+
199+
200+
201+
[license]: /LICENSE
98202
[website]: https://bloggify.org
99203
[contributing]: /CONTRIBUTING.md
100204
[docs]: /DOCUMENTATION.md

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@
4747
"db": ""
4848
}
4949
}
50-
}
50+
}

0 commit comments

Comments
 (0)