Skip to content

Commit 7da2849

Browse files
authored
docs: update readme (#49)
1 parent 67c728d commit 7da2849

20 files changed

+24
-790
lines changed

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,35 @@
1-
# Javascript Client (Browser) SDK for Experiment
1+
<p align="center">
2+
<a href="https://amplitude.com" target="_blank" align="center">
3+
<img src="https://static.amplitude.com/lightning/46c85bfd91905de8047f1ee65c7c93d6fa9ee6ea/static/media/amplitude-logo-with-text.4fb9e463.svg" width="280">
4+
</a>
5+
<br />
6+
</p>
7+
8+
9+
# Experiment Browser SDK
210

311
## Overview
412

5-
This is the Javascript client (web browser) SDK for Experiment, Amplitude's
13+
This is the JavaScript client (web browser) SDK for Experiment, Amplitude's
614
experimentation and feature management platform.
715

16+
## Getting Started
17+
18+
Refer to the [Javascript SDK Developer Documentation](https://www.docs.developers.amplitude.com/experiment/sdks/javascript-sdk/) to get started.
19+
20+
## Examples
21+
22+
This repo contains various example applications for getting familiar with the
23+
SDK usage. Each example has two applications, one with a basic example, and
24+
another with an example for integrating with the amplitude analytics SDK.
25+
26+
* Script Tag (HTML)
27+
* [Basic Example](https://github.com/amplitude/experiment-js-client/tree/main/examples/html-app/basic)
28+
* [Amplitude Analytics SDK Integration](https://github.com/amplitude/experiment-js-client/tree/main/examples/html-app/amplitude-integration)
29+
830
## Browser Compatibility
931

1032
This SDK works with all major browsers and IE10+. The SDK does make use of
1133
Promises, so if you are targeting a browser that does not have native support
1234
for Promise (for example, IE), you should include a polyfill for Promise, (for
1335
example, [es6-promise](https://github.com/stefanpenner/es6-promise)).
14-
15-
## Getting Started
16-
17-
Refer to the [Javascript SDK Documentation](https://amplitude-lab.readme.io/docs/javascript-client-sdk) to get started.

packages/browser-demo/.env

Lines changed: 0 additions & 1 deletion
This file was deleted.

packages/browser-demo/.gitignore

Lines changed: 0 additions & 23 deletions
This file was deleted.

packages/browser-demo/CHANGELOG.md

Lines changed: 0 additions & 166 deletions
This file was deleted.

packages/browser-demo/README.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

packages/browser-demo/package.json

Lines changed: 0 additions & 35 deletions
This file was deleted.

packages/browser-demo/public/amplitude-logo.svg

Lines changed: 0 additions & 13 deletions
This file was deleted.
-3.08 KB
Binary file not shown.

packages/browser-demo/public/index.html

Lines changed: 0 additions & 38 deletions
This file was deleted.

packages/browser-demo/public/robots.txt

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)