@riloservices/base 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +9 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -12,10 +12,12 @@ Rilo DB works with MongoDB drivers and tools. MongoDB is a trademark of MongoDB,
12
12
  ## Install
13
13
 
14
14
  ```bash
15
- npm install @riloservices/base mongodb
15
+ npm install @riloservices/base
16
16
  ```
17
17
 
18
- It needs Node 20.19 or later. `mongodb` (the official driver, version 6.10 or later) is a peer dependency, so your app keeps one copy of it. The package works from ES modules and from CommonJS.
18
+ This also installs the official MongoDB driver (`mongodb`, version 6.10 or later): it's a peer dependency, so your app keeps one copy of it, and npm, pnpm and Bun add it for you. With Yarn, add it yourself: `yarn add @riloservices/base mongodb`.
19
+
20
+ It needs Node 20.19 or later, and works from ES modules and from CommonJS.
19
21
 
20
22
  ## Your app key
21
23
 
@@ -34,7 +36,11 @@ RILO_KEY=rilo_in_k3m9x2qz.app.…
34
36
 
35
37
  **Keep `RILO_KEY` on your server.** Never put it in browser code, a mobile app or a public repository. The key can read and write your data, so treat it like a password. If it leaks, reset it on the App keys page.
36
38
 
37
- `RILO_KEY` is the main way in: it works for your databases and for Files.
39
+ `RILO_KEY` is the main way in, and the only value your app needs: it works for your databases and for Files.
40
+
41
+ ### Allow your app's address
42
+
43
+ Your Space only accepts database connections from its **Allowed places**. Before your app connects, add the address of the server it runs on (and your own, while you develop): open your Space, then **Settings**, then **Allowed places**. Until then, database calls fail to connect. Files doesn't use Allowed places, so it works from anywhere with the key.
38
44
 
39
45
  ## The `rilodb://` link (databases only)
40
46
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@riloservices/base",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Use a Rilo DB Space from your server with one app key: your databases through the MongoDB driver, and Files.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://db.services.rilo.studio/docs",
@@ -54,7 +54,7 @@
54
54
  "./package.json": "./package.json"
55
55
  },
56
56
  "bin": {
57
- "rilo-db": "./dist/cli.mjs"
57
+ "rilo-db": "dist/cli.mjs"
58
58
  },
59
59
  "files": [
60
60
  "dist",