diff --git a/packages/frptools/README.md b/packages/frptools/README.md index a07b699..a62f966 100644 --- a/packages/frptools/README.md +++ b/packages/frptools/README.md @@ -6,7 +6,7 @@ and derived state. # [property](./src/property.js) A `property` is a simple value store that can report when its value changes. It is good for wrapping -external values passed into a component so compute types can dependent on them and only recompute +external values passed into a component so compute types can depend on them and only recompute when these values change. It can also be used to receive events such as _window.onresize_ to always provide the current viewport size. @@ -167,7 +167,7 @@ gap). ```js const getToken = stream( async tokenUrl => fetch(tokenUrl), // computation function - [getTokenUrl] // array of dependencies, can be a property, computed or stream + [getTokenUrl, tokenTimeout] // array of dependencies, can be a property, computed or stream ); ``` diff --git a/packages/gallery/README.md b/packages/gallery/README.md index 822abb9..9e75668 100644 --- a/packages/gallery/README.md +++ b/packages/gallery/README.md @@ -36,6 +36,7 @@ localhost certificate exception in order to operate properly. In the future, I plan to add: +- convert server to use [cors-anywhere](https://github.com/Rob--W/cors-anywhere) - sharable links - local file storage - CSRF for interacting with server component diff --git a/packages/portal/README.md b/packages/portal/README.md index d5d8f78..9763c6b 100644 --- a/packages/portal/README.md +++ b/packages/portal/README.md @@ -1,4 +1,4 @@ -# [Portal](https://gitlab.com/explorigin/portal) +# Portal Portal is an utility to expose an API between Javascript contexts. For example, web workers and the DOM thread can expose methods to each other. diff --git a/packages/pouchdb-attachmentproxy/README.md b/packages/pouchdb-attachmentproxy/README.md index 3d7adbc..a049121 100644 --- a/packages/pouchdb-attachmentproxy/README.md +++ b/packages/pouchdb-attachmentproxy/README.md @@ -7,18 +7,23 @@ metadata without having the raw data bogging down your PouchDB database. ## Overview Attachment Proxy works by intercepting attachments bound for the pouchdb backend and passing them to -a custom `save` function that will return a sentry blob to be saved in the pouchdb document. +a custom `save` function that will return a blob to be saved in the pouchdb document. The returned +blob should be a smaller *sentry* blob with just enough information needed to fetch the full version +that is being proxied. `stringToBlob` is provided to make this process easier for simple string +identifier cases. Alternatively, you can pass the original attachment through if you do not want it +to be proxied. -When an attachment is requested, the sentry blob will be provided to a custom `getFn` function to be -converted into desired document. +When an attachment is requested, the document attached blob (returned from `save`) will be provided +to a custom `getFn` function to be converted into desired document. `blobToString` is provided to +make this easier for simple string identifier cases. Similar to `getFn`, the sentry blob is provided to `remove` when an attachment or its containing document is deleted. Each function is expected to be asynchronous and the database will not continue its operation until the proxy function completes to ensure data integrity. It may be desirable to for the `remove` -function to delay attachment cleanup. The proxy blob will be removed from document (effectively -orphaning the proxied attachment until it is cleaned). +function to delay attachment cleanup. In this case, the document blob will be removed from document +(effectively orphaning the proxied attachment until it is cleaned asynchronously). ## Example diff --git a/packages/projector/README.md b/packages/projector/README.md index d5ab1ae..7fcc0b2 100644 --- a/packages/projector/README.md +++ b/packages/projector/README.md @@ -1,4 +1,4 @@ -# Projector +# Projector [WIP] A DOM-abstraction communicator. Projector consumes patches to update the DOM in _frames_ and provides sanitized event objects to subscribers. This doesn't work yet. Please go look at the diff --git a/packages/router/README.md b/packages/router/README.md index 7fba2ae..013fd3d 100644 --- a/packages/router/README.md +++ b/packages/router/README.md @@ -1,6 +1,7 @@ # Router -The core functions of router that is designed to be slim and have an easy-to-read, yet powerful API. +Router encompases the core functions of a router. It is designed to be slim and have an +easy-to-read, yet powerful API. **NOTE** This router is geared toward offline-first apps and thus does not support pushState. diff --git a/packages/trimkit/README.md b/packages/trimkit/README.md index 7451827..8b5dc20 100644 --- a/packages/trimkit/README.md +++ b/packages/trimkit/README.md @@ -1,4 +1,4 @@ -# [TrimKit](https://gitlab.com/explorigin/trimkit) +# TrimKit TrimKit is a set of DOM and API abstractions for the purpose of better Javascript minification. For example: