Skip to content
This repository was archived by the owner on Apr 28, 2022. It is now read-only.

Commit 1b70487

Browse files
authored
Explain direct usage and nudge to BYO docs
1 parent 447654c commit 1b70487

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

Readme.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ For our mobile and server-side data collection libraries, check out our [librari
1414
Analytics helps you measure your users, product, and business. It unlocks insights into your app's funnel, core business metrics, and whether you have product-market fit.
1515

1616
## How to get started
17-
1. **Collect analytics data** from your app(s).
17+
18+
1. **Collect analytics data** from your app(s). Get started through Segment with our [Analytics.js Quickstart][].
1819
- The top 200 Segment companies collect data from 5+ source types (web, mobile, server, CRM, etc.).
1920
2. **Send the data to analytics tools** (for example, Google Analytics, Amplitude, Mixpanel).
2021
- Over 250+ Segment companies send data to eight categories of destinations such as analytics tools, warehouses, email marketing and remarketing systems, session recording, and more.
@@ -24,6 +25,7 @@ Analytics helps you measure your users, product, and business. It unlocks insigh
2425
[Segment](https://segment.com) collects analytics data and allows you to send it to more than 250 apps (such as Google Analytics, Mixpanel, Optimizely, Facebook Ads, Slack, Sentry) just by flipping a switch. You only need one Segment code snippet, and you can turn integrations on and off at will, with no additional code. [Sign up with Segment today](https://app.segment.com/signup).
2526

2627
### Why?
28+
2729
1. **Power all your analytics apps with the same data**. Instead of writing code to integrate all of your tools individually, send data to Segment, once.
2830

2931
2. **Install tracking for the last time**. We're the last integration you'll ever need to write. You only need to instrument Segment once. Reduce all of your tracking code and advertising tags into a single set of API calls.
@@ -43,9 +45,11 @@ Analytics helps you measure your users, product, and business. It unlocks insigh
4345
```
4446

4547
### 🚀 Startup Program
48+
4649
<div align="center">
4750
<a href="https://segment.com/startups"><img src="https://user-images.githubusercontent.com/16131737/53128952-08d3d400-351b-11e9-9730-7da35adda781.png" /></a>
4851
</div>
52+
4953
If you are part of a new startup (&lt;$5M raised, &lt;2 years since founding), we just launched a new startup program for you. You can get a Segment Team plan (up to <b>$25,000 value</b> in Segment credits) for free up to 2 years — <a href="https://segment.com/startups/">apply here</a>!
5054

5155
## Documentation
@@ -58,21 +62,31 @@ For more detail on the Analytics.js API, check out the [Analytics.js Library Ref
5862

5963
Analytics.js for Platforms is a version of analytics.js built specifically for website creation and e-commerce platforms to give their customers one-click enablement of Google Analytics, Facebook Pixel, Google Adwords, and Segment. For more information, you can check out the [docs for Analytics.js for Platforms](https://segment.com/docs/guides/partners/analyticsjs-for-platforms/). Segment hosts this version of the library for free use on its CDN.
6064

61-
## Contributing
65+
## Using this Repo
66+
67+
This repository houses a pre-built, open-source version of analytics.js. If you'd like to use Analytics.js outside of Segment but don't need to customize your build, pre-built [unminified][] or [minified][] versions of analytics.js found in the root of this repository. Once you've done that, you'll want to mimic the Segment snippet on your website by stubbing out its methods on the `window` and downloading your built version of the script asynchronously. For an example of doing that and initializing your integrations with options, [see here](https://gist.github.com/cyberwombat/11008970).
6268

63-
This repository houses a pre-built, open-source version of analytics.js. The core logic of analytics.js is broken out into individual repositories:
69+
If you're looking to produce a custom build of Analytics.js with just the plugins you need, see [Building a Custom Distribution](Building-a-Custom-Distribution).
70+
71+
## Contributing to Analytics.js and its Ecosystem of Integration Plugins
72+
73+
The core logic of analytics.js is broken out into individual repositories:
6474
6575
- To report an issue with analytics.js itself, head over to [analytics.js-core][], where the core analytics.js logic is maintained.
66-
- To report an issue with an integration. head over to the [analytics.js-integrations][] organization, where we keep each integration in its own repository.
76+
- To report an issue with an integration plugin. head over to the [analytics.js-integrations][] organization, where we keep each integration plugin in its own repository.
77+
- **To build a custom integration plugin for analytics.js, check out the [wiki][]. To distribute your plugin as a component of an integration in our [catalog][], check out our [partner docs].**
6778
6879
If you're not sure where to open an issue, feel free to open an issue against this repository or [contact us](https://segment.com/contact) and we'll help point you in the right direction.
6980

81+
[analytics.js]: https://github.com/segmentio/analytics.js
82+
[unminified]: https://github.com/segmentio/analytics.js/blob/master/analytics.js
83+
[minified]: https://github.com/segmentio/analytics.js/blob/master/analytics.min.js
84+
[analytics.js quickstart]: https://segment.com/docs/libraries/analytics.js/quickstart/
85+
7086
## License
7187

7288
Released under the [MIT license](License.md).
7389

74-
75-
7690
[analytics.js library reference]: https://segment.com/docs/libraries/analytics.js
7791
[analytics.js quickstart]: https://segment.com/docs/sources/website/analytics.js/quickstart
7892
[analytics.js-core]: https://github.com/segmentio/analytics.js-core
@@ -83,3 +97,6 @@ Released under the [MIT license](License.md).
8397
[libraries]: https://segment.com/libraries
8498
[nodejs.org]: https://nodejs.org/
8599
[spec]: https://segment.com/docs/spec/
100+
[catalog]: https://segment.com/catalog
101+
[partner docs]: https://segment.com/docs/partners
102+
[wiki]: https://github.com/segmentio/analytics.js/wiki/Writing-Integrations

0 commit comments

Comments
 (0)