Skip to content

Commit 0deea10

Browse files
authored
Update README.md
1 parent 1e04042 commit 0deea10

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,22 @@
1-
# NavAbilitySDK.js
1+
# NavAbilitySDK.js
2+
Access NavAbility Cloud factor graph features from JavaScript.
3+
4+
Note that this SDK and the related API are still in development. Please let us know if you have any issues.
5+
6+
# Installation
7+
8+
Install the NavAbilitySDK using npm:
9+
10+
```bash
11+
npm i navabilitysdk
12+
```
13+
14+
# Notes and FAQ
15+
16+
- **Which user should I use?** The Guest user is open and free for everyone to use. We recommend testing with this user, because it doesn't require any authentication. Note though, that the data is cleared on a regular basis, and that everyone can see your test data (all Guest users are created equal), so don't put anything in there that that is sensitive.
17+
- **I have sensitive data, how do I create a user?** Great question, the NavAbility services completely isolate data per user and you can create a user at any point. At the moment we create users on demand because the services are changing as we develop them, and we want to make sure we can let everyone know as they do. Send us an email at [info@navability.io](mailto:info@navability.io) and we'll create a user for you right away.
18+
- Otherwise for any questions, comments, or feedback please feel free to email us at [info@navability.io](mailto:info@navability.io) or write an issue on the repo.
19+
-
20+
# Example
21+
22+
An example repo will be released in the near future. If you need support today, please reach out to [info@navability.io](mailto:info@navability.io)

0 commit comments

Comments
 (0)