Skip to content

Commit faa4d0b

Browse files
committed
update docs
1 parent 2f8ad5a commit faa4d0b

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# snippet
1+
# @segment/snippet
22

33
Render the analytics.js snippet.
44

@@ -13,6 +13,9 @@ npm install @segment/snippet
1313

1414
# yarn
1515
yarn add @segment/snippet
16+
17+
# pnpm
18+
pnpm add @segment/snippet
1619
```
1720
## Example
1821

@@ -66,18 +69,19 @@ make test
6669
SAUCE=true make test
6770
```
6871

69-
## Releasing a new version
72+
## Releasing
7073
1. Publish to `npm`
71-
```
72-
git co master && git pull --ff-only
74+
```sh
75+
git checkout master && git pull --ff-only
7376
npm version <patch|minor|major>
7477
git push --follow-tags
7578
make build
7679
npm publish
7780
```
78-
2. Create a new github release
79-
https://github.com/segmentio/snippet/releases
81+
2. Create a [new github release](https://github.com/segmentio/snippet/releases).
8082

81-
3. Bump package version on [app repo](https://github.com/segmentio/app)
83+
3. Bump package version on [segmentio/app](https://github.com/segmentio/app/blob/main/packages/app/package.json).
8284

83-
4. Update snippet on [public docs repo](https://github.com/segmentio/docs) (search + replace)
85+
4. Update _all_ example snippets on [public docs repo](https://github.com/segmentio/segment-docs) via search + replace
86+
- Get example snippet by runnings `yarn fixture` and observing generated `tmp.fixture.*.js` files.
87+
- Tip: double-check that the fixture's `SNIPPET_VERSION` refers to the new npm version.

0 commit comments

Comments
 (0)