remote-storage - npm Package Compare versions

Comparing version 0.0.8 to 0.0.9

package.json

		{
		"name": "remote-storage",
		"version": "0.0.8",
		"description": "remoteStorage is a Javascript library with the same API as localStorage that allows you to store state in a centralized location.",
		"version": "0.0.9",
		"description": "remoteStorage is a simple library that combines the localStorage API with a remote server to persist data across browsers and devices.",
		"type": "module",
		@@ -6,0 +6,0 @@ "main": "./dist/index.js",

README.md

		[![npm version](https://img.shields.io/npm/v/remote-storage)](https://www.npmjs.com/package/global-storage)
		[![npm version](https://github.com/FrigadeHQ/remote-storage/actions/workflows/tests.yml/badge.svg)](https://github.com/FrigadeHQ/remote-storage/actions/workflows/tests.yml)
		[![tests](https://github.com/FrigadeHQ/remote-storage/actions/workflows/tests.yml/badge.svg)](https://github.com/FrigadeHQ/remote-storage/actions/workflows/tests.yml)
		[![npm license](https://img.shields.io/npm/l/remote-storage)](https://www.npmjs.com/package/remote-storage)
		[![typescript](https://camo.githubusercontent.com/0f9fcc0ac1b8617ad4989364f60f78b2d6b32985ad6a508f215f14d8f897b8d3/68747470733a2f2f62616467656e2e6e65742f62616467652f547970655363726970742f7374726963742532302546302539462539322541412f626c7565)](https://www.npmjs.com/package/@frigade/remote-storage)
		[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
		@@ -34,3 +33,3 @@
		- 🚀 Works with all Javascript frameworks
		- 📦 Lightweight (~2 kB)
		- 📦 Lightweight (~1 kB minified)
		- ✨ Open source server and client (MIT license)
		@@ -68,3 +67,3 @@ - 🍦 Free hosted community server

		remoteStorage uses user IDs to identify users. A user ID is a string that uniquely identifies a user. It can be anything you want, but we recommend using a UUID.
		remoteStorage uses user IDs to identify users. A user ID is a string that uniquely identifies a user. It can be anything you want, but we recommend using a non-iterable UUID to prevent users from guessing other user IDs and accessing their data.

		@@ -96,14 +95,19 @@ The User ID is set when you create a new instance of remoteStorage:

		We offer a free hosted community server at `https://server.centraldstorage.dev`. The server should not be used for production apps, but it's great for testing and prototyping.
		We offer a free hosted community server at `https://rs.frigade.com`. This hosted server should not be used for production apps, but it's great for testing and prototyping.

		The server can be spun up using Docker in a few minutes. To get started, simply clone the repository and run `docker-compose up`:
		The server can be spun up using Docker in a few minutes. See the [server documentation](/apps/remote-storage-server/README.md) for more information.

		```bash
		git clone git@github.com:FrigadeHQ/remote-storage.git
		cd remote-storage/apps/server
		docker-compose up
		```

		The server runs on port 4000 by default.
		### FAQ

		#### What data should I store in remoteStorage?

		remoteStorage should only be used for non-sensitive data. We recommend using it for things like user preferences, settings, and other non-sensitive data. Due to the nature of the public API, it's not a good fit for storing sensitive data like passwords or PII.

		#### How is remoteStorage different from localStorage?

		localStorage is a browser API that allows you to store data in the browser. The data is stored locally on the user's device and is not shared across devices or browsers. remoteStorage is a library that combines the localStorage API with a remote server to persist data across browsers and devices.

		#### Can't anyone just guess a user ID and access someone else's data?

		Yes, but that's why you should use a non-iterable UUID for your user IDs. This makes it impossible for users to guess other user IDs and access their data unless they know the user ID.

remote-storage - npm Package Compare versions

Improved metrics