Skip to content

Commit

Permalink
chore: disable publishing to NPM and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jbms committed Feb 26, 2024
1 parent e4d5291 commit ddc325b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 18 deletions.
12 changes: 7 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -194,11 +194,13 @@ jobs:
user: __token__
password: ${{ secrets.pypi_token }}
if: ${{ startsWith(github.ref, 'refs/tags/v') }}
- name: Publish to NPM registry
run: npm publish
working-directory: npm-package
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
# Disabling publishing to NPM
# - name: Publish to NPM registry
# if: ${{ startsWith(github.ref, 'refs/tags/v') }}
# run: npm publish
# working-directory: npm-package
# env:
# NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
ngauth:
strategy:
matrix:
Expand Down
16 changes: 3 additions & 13 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,15 @@ a client-side web application.
WARNING: Neuroglancer does not yet offer any stability guarantees for the
JavaScript API.

Neuroglancer can be used as a dependency in three ways:
Neuroglancer can be used as a dependency in two ways:

1. Installing the published npm package via:

```shell
npm install neuroglancer
```

This will use the built Neuroglancer package, with the TypeScript sources
already transpiled to JavaScript. This is the normal, recommended way to use
Neuroglancer and imposes the least requirements.

2. Installing directly from the Github repository, via:
1. Installing directly from the Github repository, via:

```shell
npm install google/neuroglancer
```

3. Linking to a local checkout of the Neuroglancer repository via:
2. Linking to a local checkout of the Neuroglancer repository via:

```shell
npm link neuroglancer
Expand Down

0 comments on commit ddc325b

Please sign in to comment.