Skip to content

Commit 275d5a3

Browse files
committed
update monorepo README with development instructions and badges
1 parent d2e7ba9 commit 275d5a3

File tree

2 files changed

+30
-6
lines changed

2 files changed

+30
-6
lines changed

DEVELOPMENT.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Development
2+
3+
```sh
4+
git clone [email protected]:segmentio/analytics-next.git && cd analytics-next
5+
nvm use # install version of node defined in .nvmrc.
6+
yarn && yarn build
7+
yarn lint && yarn test
8+
```

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,32 @@
1-
# Segment Analytics JS
1+
<div style="display:flex;margin-bottom:5px">
2+
<span style="margin: 0 5px 5px">
3+
<a href="https://buildkite.com/segment/analytics-next">
4+
<img src="https://badge.buildkite.com/87e30d62ada044b6fe404b17cd16aa6e3b52d89f40c9f44675.svg?branch=master">
5+
</a>
6+
7+
</span>
8+
<span style="margin:0 5px 5px">
9+
<a href="http://www.typescriptlang.org/">
10+
<img src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg">
11+
</span>
12+
</div>
13+
214
<p align="center">
315
<a href="https://segment.com">
416
<img src="https://brand.segment.com/site-assets/7b19c1a2/images/brand-guidelines/content/twilio/twilio-segment-logo-2x.png" width="300">
517
</a>
618
<br />
7-
<caption>Welcome to the monorepo for Segment's Javascript SDKs!</caption>
19+
<caption>Welcome to the monorepo for Segment's latest Javascript / Typescript SDKs</caption>
820
</p>
921

10-
## NPM Packages
11-
* [@segment/analytics-next](packages/browser#readme): Analytics SDK for web browsers
12-
* [@segment/analytics-node](packages/node#readme) (⚠️ Beta): Segment Analytics SDK for Node.js
22+
# analytics.js (analytics-next)
1323

24+
## Packages
25+
26+
- [@segment/analytics-next](packages/browser#readme): Analytics.js SDK for **web browsers**
27+
- [@segment/analytics-node](packages/node#readme) (⚠️ Beta): Analytics.js SDK for **Node.js**
1428

1529
## Contributing
16-
Check out our contribution guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)
30+
31+
- Contribution guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)
32+
- Development instructions: [DEVELOPMENT.md](DEVELOPMENT.md)

0 commit comments

Comments
 (0)