Skip to content

Commit

Permalink
Merge pull request #118 from Kinto/remove-mentions-of-cliquet
Browse files Browse the repository at this point in the history
Remove mentions of Cliquet
  • Loading branch information
Natim committed Sep 4, 2015
2 parents c9bff18 + bf5c670 commit 5a2bfd5
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const db = new Kinto(options);
`options` is an object defining the following option values:

- `remote`: The remote Kinto server endpoint root URL (eg. `"https://server/v1"`). Not that you *must* define a URL matching the version of the protocol the client supports, otherwise you'll get an error;
- `headers`: The default headers to pass for every HTTP request performed to the Cliquet server (eg. `{"Authorization": "Basic bWF0Og=="}`);
- `headers`: The default headers to pass for every HTTP request performed to the Kinto server (eg. `{"Authorization": "Basic bWF0Og=="}`);
- `adapter`: The persistence layer adapter to use for saving data locally (default: `Kinto.adapters.IDB`); alternatively, a `Kinto.adapters.LocalStorage` adapter is also provided; last, if you plan on writing your own adapter, you can read more about how to do so in the [Extending Kinto.js](extending.md) section.
- `requestMode`: The HTTP [CORS](https://fetch.spec.whatwg.org/#concept-request-mode) mode. Default: `cors`.
- `dbPrefix`: The prefix for the local database name (default: `""`). Use this option to isolate different specific databases, eg. for storing distinct users data.
Expand Down Expand Up @@ -339,7 +339,7 @@ Here we're solving encountered conflicts by picking all remote versions. After c

## Handling server backoff

If the Kinto server instance is under heavy load or maintenance, their admins can [send a Backoff header](http://cliquet.readthedocs.org/en/latest/api/backoff.html) and it's the responsibily for clients to hold on performing more requests for a given amount of time, expressed in seconds.
If the Kinto server instance is under heavy load or maintenance, their admins can [send a Backoff header](http://kinto.readthedocs.org/en/latest/api/cliquet/backoff.html) and it's the responsibily for clients to hold on performing more requests for a given amount of time, expressed in seconds.

When this happens, Kinto.js will reject calls to `#sync()` with an appropriate error message specifying the number of seconds you need to wait before calling it again.

Expand Down
4 changes: 2 additions & 2 deletions docs/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Kinto.js doesn't track modification history in a form of a revision tree. Instea

This allows covering 80% of common synchronization use cases, while being super-lightweight implementation wise.

You can read more about the rationale [here](http://cliquet.readthedocs.org/en/latest/rationale.html).
You can read more about Kinto features [here](http://kinto.readthedocs.org).

### No automatic confict handling

Expand Down Expand Up @@ -59,7 +59,7 @@ For now only a few standard fields are indexed by default in IndexedDB collectio
Here's what's planned for future versions, outside of fixing the known limitations listed above:

- Adding a **client-side crypto layer** to the API in order to bring secure & privacy-safe remote storage of user data;
- Adding support for [**sharing & permissions**](http://cliquet.readthedocs.org/en/latest/reference/permission.html);
- Adding support for [**sharing & permissions**](http://kinto.readthedocs.org/en/latest/api/permissions.html);
- Allowing to use **other local storage backend than IndexedDB** (localStorage, WebSQL) in the form of alternative drivers/adapters;
- Providing an **admin Web UI** allowing easy management of your Kinto buckets and collections.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "kinto",
"version": "1.0.0-rc.3",
"description": "JavaScript client for Cliquet.",
"description": "JavaScript client for Kinto.",
"main": "lib/index.js",
"scripts": {
"build": "babel -d lib/ src/",
Expand Down

0 comments on commit 5a2bfd5

Please sign in to comment.