chloedb 0.0.0-stage → 0.0.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 (3) hide show
  1. package/README.md +10 -2
  2. package/index.js +4 -0
  3. package/package.json +9 -4
package/README.md CHANGED
@@ -1,3 +1,11 @@
1
- # Temporary Holding Version
1
+ # chloedb (placeholder)
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ This version holds the name `chloedb` for [Strata](https://github.com/chloetech-ai/strata), an embedded search database with SQL. It contains no code: importing it throws an error that says where to get Strata.
4
+
5
+ Install a release from GitHub, where each `strata-js-v<version>` release has a package per platform, for example:
6
+
7
+ ```sh
8
+ npm install https://github.com/chloetech-ai/strata/releases/download/strata-js-v0.1.0/strata-db-0.1.0-darwin-arm64.tgz
9
+ ```
10
+
11
+ The list of platforms is in [docs/strata/javascript.md](https://github.com/chloetech-ai/strata/blob/main/docs/chloedb/javascript.md). Releases will be published here later.
package/index.js ADDED
@@ -0,0 +1,4 @@
1
+ throw new Error(
2
+ "chloedb 0.0.1 is a placeholder that holds the name for Strata (https://github.com/chloetech-ai/strata). " +
3
+ "Install a release from GitHub instead; see https://github.com/chloetech-ai/strata/blob/main/docs/chloedb/javascript.md"
4
+ );
package/package.json CHANGED
@@ -1,6 +1,11 @@
1
1
  {
2
2
  "name": "chloedb",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.0.1",
4
+ "description": "Placeholder: holds the name for Strata. Install releases from https://github.com/chloetech-ai/strata/releases",
5
+ "license": "Apache-2.0",
6
+ "repository": { "type": "git", "url": "git+https://github.com/chloetech-ai/chloedb.git", "directory": "packaging/chloedb/npm" },
7
+ "homepage": "https://github.com/chloetech-ai/strata",
8
+ "type": "module",
9
+ "main": "./index.js",
10
+ "files": ["index.js", "README.md"]
11
+ }