Fill out a bit more of the README

This commit is contained in:
Starbeamrainbowlabs 2019-04-27 01:06:42 +01:00
parent 71fc76521a
commit 736ff48838
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
1 changed files with 10 additions and 1 deletions

View File

@ -2,11 +2,14 @@
> Client and server-side routing micro frameworks
_Powerahroot_ is a pair of micro routing frameworks, presented as an ES6 module:
_Powahroot_ is a pair of micro routing frameworks, presented as an ES6 module:
- The first is for client-side single-page web applications
- The other is for handling server-side Node.js requests
It's based on [`rill`](https://www.npmjs.com/package/rill) (see the npm package bearing the name), but stripped down and simplified.
## Getting Started
Install powahroot as a dependency with npm:
@ -48,6 +51,12 @@ const router = new ClientRouter({
});
```
### Server
TODO: Finish this section
### Reference
TODO: Generate reference from code automatically
## Licence
Everything in this repository _except_ the logo is licenced under the _Mozilla Public License 2.0.