Skip to content

Commit

Permalink
readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jeff-zucker committed Jun 5, 2019
1 parent 470d9f6 commit febd871
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This package sits between auth modules like solid-auth-client and solid-auth-cli

<img src="https://github.com/jeff-zucker/solid-rest/blob/master/sold-rest.png" alt="diagram of solid-rest">

This package provides request routing, header handling, response preparation, and a test framework. Storage modules can leverage all of that and/or over-ride what they want. I am preparing an API guide, in the meantime there is documentation in the [localStorage](./src/localStorage.js).
**For those who want to use file:// or app:// URLs** Soon, solid-rest will be included in the auth modules. At that point, in a nodejs app, you simply require solid-rest and then use the extra URLs and in a browser app you supply script tags for solid-rest and for whichever of the app:// handlers you want.

**For those who want to create other storage handlers:** This package provides request routing, header handling, response preparation, and a test framework. Storage modules can leverage all of that and/or over-ride what they want. I am preparing an API guide, in the meantime there is documentation in the [localStorage](./src/localStorage.js) file.

copyright &copy; 2019, Jeff Zucker, may be freely distributed with the MIT license

0 comments on commit febd871

Please sign in to comment.