@audiotool/nexus 0.0.7 → 0.0.8
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 +4 -34
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,37 +1,7 @@
|
|
|
1
|
-
# Audiotool SDK
|
|
1
|
+
# Audiotool Nexus SDK
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Th official Audiotool Nexus SDK, allowing you to connect to a multiplayer session on https://beta.audiotool.com/ and modify projects in real time.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
- `src/exports/*.ts` - the entry points of the package
|
|
7
|
-
- `src/docs/` docs `.md` pages
|
|
8
|
-
- `tests` - tests of the package in various platforms (bun, node, ...)
|
|
9
|
-
- `codegen` - code generators executed when running `npm run codegen`
|
|
5
|
+
See the documentation at https://developer.audiotool.com/js-package-documentation/.
|
|
10
6
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
- `tsconfig.ts`: path aliases like `@gen/`, `@utils`
|
|
14
|
-
- `vite.config.ts`: same aliases but used by vite's bundler
|
|
15
|
-
- `package.json`: defines what of the `dist/` dir should be exported by package
|
|
16
|
-
- `typedoc.json`: defines what of the unbundled source code should be considered "entry points" of the package
|
|
17
|
-
|
|
18
|
-
## Running tests in `tests/`:
|
|
19
|
-
|
|
20
|
-
Add env var `AT_PAT=<pat>` with PAT found at https://developer.audiotool.com/personal-access-tokens.
|
|
21
|
-
|
|
22
|
-
## Testing the package
|
|
23
|
-
|
|
24
|
-
To test what the package does when built, create a new project with npm or bun somewhere. Then:
|
|
25
|
-
|
|
26
|
-
1. in this directory, call `npm/bun link`
|
|
27
|
-
2. in your new directory, call `npm/bun link @audiotool/nexus --save`
|
|
28
|
-
|
|
29
|
-
When you call `npm run build` here, the other repository will automatically update (`link` creates a dyn link to this repo).
|
|
30
|
-
|
|
31
|
-
What's finally uploaded to npm can be seen by calling `npm run pack`, which generates a `.tgz` file in `dist/`; this file can then be installed with:
|
|
32
|
-
|
|
33
|
-
```
|
|
34
|
-
npm/bun install <file>.tgz
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
What's installed in `node_modules` is what's part of the final package on npm. This should be what's in `dist/`, including the `README.md` copied from `src/docs/README.md`.
|
|
7
|
+
This package is currently at version 0.0.x. Expect breaking changes between minor versions.
|