Update readme

parent 6e7fcf5e
......@@ -4,12 +4,10 @@
## About
This project uses [Feathers](http://feathersjs.com). An open source web framework for building modern real-time applications.
This is a very early exploration.
## Getting Started
Getting up and running is as easy as 1, 2, 3.
1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
2. Install your dependencies
......@@ -25,20 +23,7 @@ Getting up and running is as easy as 1, 2, 3.
## Testing
Simply run `npm test` and all your tests in the `test/` directory will be run.
## Scaffolding
Feathers has a powerful command line interface. Here are a few things it can do:
```
$ npm install -g @feathersjs/cli # Install Feathers CLI
$ feathers generate service # Generate a new Service
$ feathers generate hook # Generate a new Hook
$ feathers generate model # Generate a new Model
$ feathers help # Show all commands
```
Simply run `./test` and all tests in the `test/` directory will be run.
## Help
......@@ -46,12 +31,12 @@ For more information on all the things you can do with Feathers visit [docs.feat
## Changelog
__0.1.0__
__1.0.0__
- Initial release
## License
Copyright (c) 2016
Copyright (c) 2018 Ind.ie.
Licensed under the [MIT license](LICENSE).
Licensed under the [AGPL](LICENSE).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment