Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: use next tag in getting started docs #102

Merged
merged 3 commits into from
Aug 28, 2023
Merged

docs: use next tag in getting started docs #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1edbc35
chore: use next tag in docs
manzt Aug 28, 2023
850cdb9
ci: lint published exports
manzt Aug 28, 2023
9723c13
chore: include in npm install
manzt Aug 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
pnpm install
pnpm build
pnpm test
pnpm publint

Lint:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ classDiagram
### In Browser (or Deno)

```javascript
import * as zarr from "https://esm.sh/zarrita";
import * as zarr from "https://esm.sh/zarrita@next";
```

### In Node.js or Application Bundles
Expand Down
26 changes: 13 additions & 13 deletions docs/get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ automatically loads the other dependencies.
```html
<!DOCTYPE html>
<script type="module">
import * as zarr from "https://cdn.jsdelivr.net/npm/zarrita@0.3/+esm";
import * as zarr from "https://cdn.jsdelivr.net/npm/zarrita@next/+esm";
const store = new zarr.FetchStore("https://raw.githubusercontent.com/zarr-developers/zarr_implementations/5dc998ac72/examples/zarr.zr/blosc");
const arr = await zarr.open(store, { kind: "array" });
// {
Expand All @@ -48,7 +48,7 @@ automatically loads the other dependencies.
```html
<!DOCTYPE html>
<script type="module">
import * as zarr from "https://esm.sh/zarrita@0.3";
import * as zarr from "https://esm.sh/zarrita@next";
const store = new zarr.FetchStore("https://raw.githubusercontent.com/zarr-developers/zarr_implementations/5dc998ac72/examples/zarr.zr/blosc");
const arr = await zarr.open(store, { kind: "array" });
// {
Expand All @@ -74,11 +74,11 @@ automatically loads the other dependencies.
<script type="importmap">
{
"imports": {
"zarrita": "https://unpkg.com/zarrita@0.3",
"@zarrita/core": "https://unpkg.com/@zarrita/core@0.0",
"@zarrita/typedarray": "https://unpkg.com/@zarrita/typedarray@0.0",
"@zarrita/indexing": "https://unpkg.com/@zarrita/indexing@0.0",
"@zarrita/storage/fetch": "https://unpkg.com/@zarrita/storage@0.0/dist/src/fetch.js",
"zarrita": "https://unpkg.com/zarrita@next",
"@zarrita/core": "https://unpkg.com/@zarrita/core@next",
"@zarrita/typedarray": "https://unpkg.com/@zarrita/typedarray@next",
"@zarrita/indexing": "https://unpkg.com/@zarrita/indexing@next",
"@zarrita/storage/fetch": "https://unpkg.com/@zarrita/storage@next/dist/src/fetch.js",
"numcodecs/blosc": "https://unpkg.com/numcodecs@0.2/blosc",
"numcodecs/lz4": "https://unpkg.com/numcodecs@0.2/lz4",
"numcodecs/zlib": "https://unpkg.com/numcodecs@0.2/zlib",
Expand Down Expand Up @@ -116,22 +116,22 @@ via yarn, npm, pnpm:

::: tabs key:pkg

== yarn
== npm

```sh
yarn add zarrita
npm install zarrita@next
```

== npm
== pnpm

```sh
npm install zarrita
pnpm add zarrita@next
```

== pnpm
== yarn

```sh
pnpm add zarrita
yarn add zarrita@next
```

:::
Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
{
"imports": {
"@zarrita/core": "./packages/core/dist/src/index.js",
"@zarrita/typedarray": "./packages/typedarray/index.js",
"@zarrita/typedarray": "./packages/typedarray/dist/src/index.js",
"@zarrita/indexing": "./packages/indexing/dist/src/index.js",
"@zarrita/storage/fetch": "./packages/storage/dist/src/fetch.js",
"numcodecs/blosc": "./packages/core/node_modules/numcodecs/blosc.js",
Expand Down