From 62ce80e1207b12ddd5113e7026912a562d77a1dd Mon Sep 17 00:00:00 2001 From: Mariocoski Date: Sat, 23 Mar 2019 00:50:03 +0000 Subject: [PATCH] fix: changed readme --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c6721fb..bb13649 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,17 @@ ![jscpd](assets/jscpd-badge.svg) [![Known Vulnerabilities](https://snyk.io/test/github/js-items/foundation/badge.svg?targetFile=package.json)](https://snyk.io/test/github/js-items/foundation?targetFile=package.json) -Provides set of interfaces, utils and tests for concrete implementations of js-items repositories +Provides set of interfaces, utils and tests for concrete implementations of js-items repositories. + +There is a fantastic alternative to this project (and @js-items is based on it): +[js-entity-repos](https://github.com/js-entity-repos). + +The main differences to the @js-entity-repos: +- different naming convention: using `item` instead of `entity` +- cursor based pagination operates using `before` and `after` instead of `cursor` and `direction` ## Installation `npm i --save-dev @js-items/foundation` -This package is heavily inspired by: -- [js-entity-repos](https://github.com/js-entity-repos) - Credits: - [ryansmith94](https://github.com/ryansmith94)