Updated readme

README.md

@@ -1,3 +1,92 @@
 # prefew
-## Under construction
-Not much to see right now. Come back lator! :crocodile:
+
+
+<a href="https://raw.githubusercontent.com/Jaid/prefew/master/license.txt"><img src="https://img.shields.io/github/license/Jaid/prefew?style=flat-square" alt="License"/></a>  
+<a href="https://actions-badge.atrox.dev/Jaid/prefew/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2FJaid%2Fprefew%2Fbadge" alt="Build status"/></a> <a href="https://github.com/Jaid/prefew/commits"><img src="https://img.shields.io/github/commits-since/Jaid/prefew/v1.0.0?style=flat-square&logo=github" alt="Commits since v1.0.0"/></a> <a href="https://github.com/Jaid/prefew/commits"><img src="https://img.shields.io/github/last-commit/Jaid/prefew?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/Jaid/prefew/issues"><img src="https://img.shields.io/github/issues/Jaid/prefew?style=flat-square&logo=github" alt="Issues"/></a>  
+<a href="https://npmjs.com/package/prefew"><img src="https://img.shields.io/npm/v/prefew?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/Jaid/prefew/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/prefew?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/prefew"><img src="https://img.shields.io/npm/dm/prefew?style=flat-square&logo=npm" alt="Downloads"/></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Installation
+<a href="https://npmjs.com/package/prefew"><img src="https://img.shields.io/badge/npm-prefew-C23039?style=flat-square&logo=npm" alt="prefew on npm"/></a>
+```bash
+npm install --global prefew@^1.0.0
+```
+<a href="https://yarnpkg.com/package/prefew"><img src="https://img.shields.io/badge/Yarn-prefew-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="prefew on Yarn"/></a>
+```bash
+yarn global add prefew@^1.0.0
+```
+
+
+
+
+## CLI Usage
+After installing package `prefew` globally, you can use its command line interface.
+```bash
+prefew
+```
+For usage instructions:
+```bash
+prefew --help
+```
+
+
+
+
+## Development
+
+
+
+Setting up:
+```bash
+git clone git@github.com:Jaid/prefew.git
+cd prefew
+npm install
+```
+Testing:
+```bash
+npm run test:dev
+```
+Testing in production environment:
+```bash
+npm run test
+```
+
+
+## License
+```text
+MIT License
+
+Copyright © 2019, Jaid <jaid.jsx@gmail.com> (github.com/jaid)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```