mirror of
https://github.com/sbrl/powahroot.git
synced 2024-11-24 23:23:00 +00:00
Fill out a bit more of the README
This commit is contained in:
parent
71fc76521a
commit
736ff48838
1 changed files with 10 additions and 1 deletions
11
README.md
11
README.md
|
@ -2,11 +2,14 @@
|
||||||
|
|
||||||
> Client and server-side routing micro frameworks
|
> 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 first is for client-side single-page web applications
|
||||||
- The other is for handling server-side Node.js requests
|
- 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
|
## Getting Started
|
||||||
Install powahroot as a dependency with npm:
|
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
|
## Licence
|
||||||
Everything in this repository _except_ the logo is licenced under the _Mozilla Public License 2.0.
|
Everything in this repository _except_ the logo is licenced under the _Mozilla Public License 2.0.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue