@digitalculture/ochre-sdk 0.1.20 → 0.1.22
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.
- package/README.md +34 -4
- package/dist/index.cjs +2121 -0
- package/dist/index.d.cts +1698 -0
- package/dist/index.d.ts +1698 -0
- package/dist/index.js +2045 -0
- package/package.json +26 -15
package/README.md
CHANGED
|
@@ -1,15 +1,45 @@
|
|
|
1
1
|
# OCHRE SDK
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This is the OCHRE JavaScript/TypeScript SDK for interacting with OCHRE (Online Cultural and Historical Research Environment) data.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
pnpm add @
|
|
8
|
+
pnpm add @digital-culture/ochre-sdk
|
|
9
|
+
```
|
|
10
|
+
|
|
9
11
|
or
|
|
10
|
-
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @digital-culture/ochre-sdk
|
|
15
|
+
```
|
|
16
|
+
|
|
11
17
|
or
|
|
12
|
-
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
bun add @digital-culture/ochre-sdk
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Start development server
|
|
24
|
+
|
|
25
|
+
From the root directory of the project, run the following command:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
pnpm run dev:ochre-sdk
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Build production server
|
|
32
|
+
|
|
33
|
+
From the root directory of the project, run the following command:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
pnpm run ci
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Release new version to NPM
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pnpm run release
|
|
13
43
|
```
|
|
14
44
|
|
|
15
45
|
## Features
|