diff --git a/packages/pouchdb-attachmentproxy/README.md b/packages/pouchdb-attachmentproxy/README.md index a049121..b100ce1 100644 --- a/packages/pouchdb-attachmentproxy/README.md +++ b/packages/pouchdb-attachmentproxy/README.md @@ -7,10 +7,10 @@ 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 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 +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 document attached blob (returned from `save`) will be provided