Skip to content

Commit 4ff879c

Browse files
authored
Merge pull request #1 from felt/update-readme
Update README
2 parents e49dae8 + c4134f5 commit 4ff879c

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Felt JS SDK React Starter
22

3-
This repo shows how you can use the Felt JS SDK to interact with embedded Felt maps.
3+
This repo shows how you can use the [Felt JS SDK](https://github.com/felt/js-sdk) with React to interact with embedded Felt maps.
44

5-
The preelease documentation is available [here](https://felt-1.gitbook.io/prerelease-api/sbIy6fOyyRJ35iaR2jim/js-api/main)
5+
- [Documentation](https://developers.felt.com/js-sdk)
6+
- [API Reference](https://developers.felt.com/js-sdk-api-reference)
7+
8+
## Getting started
69

710
To run the project, run `npm install` and then `npm run dev`.
811

0 commit comments

Comments
 (0)