Skip to content

Commit ddc325b

Browse files
committed
chore: disable publishing to NPM and update docs
1 parent e4d5291 commit ddc325b

File tree

2 files changed

+10
-18
lines changed

2 files changed

+10
-18
lines changed

.github/workflows/build.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -194,11 +194,13 @@ jobs:
194194
user: __token__
195195
password: ${{ secrets.pypi_token }}
196196
if: ${{ startsWith(github.ref, 'refs/tags/v') }}
197-
- name: Publish to NPM registry
198-
run: npm publish
199-
working-directory: npm-package
200-
env:
201-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
197+
# Disabling publishing to NPM
198+
# - name: Publish to NPM registry
199+
# if: ${{ startsWith(github.ref, 'refs/tags/v') }}
200+
# run: npm publish
201+
# working-directory: npm-package
202+
# env:
203+
# NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
202204
ngauth:
203205
strategy:
204206
matrix:

examples/README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,15 @@ a client-side web application.
44
WARNING: Neuroglancer does not yet offer any stability guarantees for the
55
JavaScript API.
66

7-
Neuroglancer can be used as a dependency in three ways:
7+
Neuroglancer can be used as a dependency in two ways:
88

9-
1. Installing the published npm package via:
10-
11-
```shell
12-
npm install neuroglancer
13-
```
14-
15-
This will use the built Neuroglancer package, with the TypeScript sources
16-
already transpiled to JavaScript. This is the normal, recommended way to use
17-
Neuroglancer and imposes the least requirements.
18-
19-
2. Installing directly from the Github repository, via:
9+
1. Installing directly from the Github repository, via:
2010

2111
```shell
2212
npm install google/neuroglancer
2313
```
2414

25-
3. Linking to a local checkout of the Neuroglancer repository via:
15+
2. Linking to a local checkout of the Neuroglancer repository via:
2616

2717
```shell
2818
npm link neuroglancer

0 commit comments

Comments
 (0)