Skip to content
This repository was archived by the owner on Jun 22, 2021. It is now read-only.

Commit 4745338

Browse files
committed
docs(readme): Adds usage instructions.
1 parent 03d9a3c commit 4745338

File tree

1 file changed

+5
-14
lines changed

1 file changed

+5
-14
lines changed

readme.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,7 @@
1-
# core
2-
> Provides common interfaces and tests for concrete implementations of js-entity-repos.
1+
# todos
2+
> Demonstrates js-entity-repos with todos.
33
44
### Usage
5-
- Install it with `npm i @js-entity-repos/core`.
6-
- Understand it by reading the [documenation](./docs/facade.md).
7-
8-
### FeathersJS
9-
The project has some similarities with parts of the [FeathersJS framework](feathersjs.com), but unfortunately I've found the following issues with FeathersJS.
10-
11-
- Their pagination uses skip and limit instead of cursors which causes [issues as discussed by Rakhitha Nimesh](https://www.sitepoint.com/paginating-real-time-data-cursor-based-pagination/).
12-
- Their service interface is missing some functions provided in the [Facade](./docs/facade.md) here.
13-
- Their errors take messages instead of parameters making it harder to support localisation.
14-
15-
### Thanks
16-
Thanks to [James](https://github.com/ht2), [Mariusz](https://github.com/mariocoski), and [Pete](https://github.com/ee0pdt) at [HT2 Labs](https://www.ht2labs.com) for their feedback.
5+
- Clone it with `git clone [email protected]:js-entity-repos/todos.git todos`.
6+
- Install dependencies with `npm install`.
7+
- Try it with `npm run dev`.

0 commit comments

Comments
 (0)