Skip to content

Commit 7f21688

Browse files
committed
Update README
1 parent 4de2318 commit 7f21688

File tree

2 files changed

+31
-12
lines changed

2 files changed

+31
-12
lines changed

README.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
1+
![Clarifai logo](logo.png)
2+
3+
# Clarifai API JavaScript Client
4+
5+
This is the official JavaScript client for interacting with our powerful recognition
6+
[API](https://developer.clarifai.com). The Clarifai API offers image and video recognition as a service. Whether you
7+
have one image or billions, you are only steps away from using artificial intelligence to recognize your visual content.
8+
9+
* Try the Clarifai demo at: https://clarifai.com/demo
10+
* Sign up for a free account at: https://clarifai.com/developer/account/signup/
11+
* Read the developer guide at: https://clarifai.com/developer/guide/
12+
13+
114
[![Build Status](https://travis-ci.org/Clarifai/clarifai-javascript.svg?branch=master)](https://travis-ci.org/Clarifai/clarifai-javascript)
215
[![npm version](https://badge.fury.io/js/clarifai.svg)](https://badge.fury.io/js/clarifai)
316

4-
# Clarifai JavaScript Client
5-
6-
The official JavaScript client for interacting with the [Clarifai API](https://clarifai.com/developer/guide/).
17+
## Installation
18+
Install the API client:
19+
```
20+
npm install clarifai
21+
```
722

823
## Basic Use
924

10-
To start, install the SDK via NPM: `npm install clarifai` and initialize with your api key:
25+
Firstly, generate your Clarifai API key [on the API keys page](https://clarifai.com/developer/account/keys). The client
26+
uses it for authentication.
1127

12-
*This will work in node.js and browsers via [Browserify](http://browserify.org/)*
28+
Then, use the code below to create a `Clarifai.App` instance using which you interact with the client.
1329

1430
```js
1531
const Clarifai = require('clarifai');
@@ -19,19 +35,15 @@ const app = new Clarifai.App({
1935
});
2036
```
2137

38+
*This will work in node.js and browsers via [Browserify](http://browserify.org/).*
39+
2240
You can also use the SDK by adding this script to your HTML:
2341

2442
```html
2543
<script type="text/javascript" src="https://sdk.clarifai.com/js/clarifai-latest.js"></script>
2644
```
2745

28-
## React Native
29-
30-
You'll most likely encounter the error `process.nextTick is not a function` while using this library with React Native.
31-
32-
To solve this, add `process.nextTick = setImmediate;` as close to the top of your entrypoint as you can. See [#20](https://github.com/Clarifai/clarifai-javascript/issues/20) for more info.
33-
34-
## Docs
46+
## Documentation
3547

3648
Dive right into code examples to get up and running as quickly as possible with our [Quick Start](https://developer.clarifai.com/quick-start/).
3749

@@ -41,6 +53,13 @@ Check out the [JSDoc](https://sdk.clarifai.com/js/latest/index.html) for a deepe
4153

4254
Looking for a different client? We have many languages available with lots of documentation [Technical Reference](https://clarifai.com/developer/reference)
4355

56+
## React Native
57+
58+
You'll most likely encounter the error `process.nextTick is not a function` while using this library with React Native.
59+
60+
To solve this, add `process.nextTick = setImmediate;` as close to the top of your entrypoint as you can. See [#20](https://github.com/Clarifai/clarifai-javascript/issues/20) for more info.
61+
62+
4463
## License
4564

4665
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.

logo.png

4.69 KB
Loading

0 commit comments

Comments
 (0)