Skip to content

Commit 3d2d168

Browse files
authored
Update readme (#7)
* Rename Package * Remove Mongoose Schema Choice, It's must * Update Readme File
1 parent e20f894 commit 3d2d168

File tree

1 file changed

+56
-3
lines changed

1 file changed

+56
-3
lines changed

readme.md

Lines changed: 56 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,56 @@
1-
<h1 align="center"> MONGODB-SCHEMA-CLI
2-
</h1>
3-
...
1+
<h1 align="center">Welcome to mongoose-schema-cli 👋</h1>
2+
<p>
3+
<a href="https://www.npmjs.com/package/mongoose-schema-cli" target="_blank">
4+
<img alt="Version" src="https://img.shields.io/npm/v/mongoose-schema-cli.svg">
5+
</a>
6+
<a href="https://github.com/eKhattak/mongoose-schema-cli#readme" target="_blank">
7+
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
8+
</a>
9+
<a href="https://github.com/eKhattak/mongoose-schema-cli/graphs/commit-activity" target="_blank">
10+
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
11+
</a>
12+
<a href="https://github.com/eKhattak/mongoose-schema-cli/blob/master/LICENSE" target="_blank">
13+
<img alt="License: MIT" src="https://img.shields.io/badge/LICENSE-MIT-blue.svg" />
14+
</a>
15+
<a href="https://twitter.com/khattakdev" target="_blank">
16+
<img alt="Twitter: khattakdev" src="https://img.shields.io/twitter/follow/khattakdev.svg?style=social" />
17+
</a>
18+
</p>
19+
20+
> A MongoDB Schema Generator CLI
21+
22+
### [Demo](https://github.com/eKhattak/mongoose-schema-cli)
23+
24+
## Install
25+
26+
```sh
27+
npm install --save mongoose-schema-cli
28+
```
29+
30+
## Usage
31+
32+
```sh
33+
msc-gen
34+
```
35+
36+
## Author
37+
38+
👤 **Arsalan Khattak <[email protected]>**
39+
40+
- Website: https://khattak.dev/
41+
- Twitter: [@khattakdev](https://twitter.com/khattakdev)
42+
- Github: [@eKhattak](https://github.com/eKhattak)
43+
- LinkedIn: [@khattakdev](https://linkedin.com/in/khattakdev)
44+
45+
## 🤝 Contributing
46+
47+
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/eKhattak/mongoose-schema-cli/issues).
48+
49+
## Show your support
50+
51+
Give a ⭐️ if this project helped you!
52+
53+
## 📝 License
54+
55+
Copyright © 2020 [Arsalan Khattak <[email protected]>](https://github.com/eKhattak).<br />
56+
This project is [MIT](https://github.com/eKhattak/mongoose-schema-cli/blob/master/LICENSE) licensed.

0 commit comments

Comments
 (0)