Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Explicitly mention to install OneSDK in fast track #89

Merged
merged 1 commit into from Jun 16, 2022
Merged

Explicitly mention to install OneSDK in fast track #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/index.md
View file
Open in desktop
Expand Up @@ -19,17 +19,18 @@ id: introduction

## Fast track ⏱️

The easiest way to start is with [OneSDK](https://github.com/superfaceai/one-sdk-js) for Node.js and with an existing use-case. Let's say, you want to see what repositories Superface has on GitHub.
The easiest way to start is with [OneSDK](https://github.com/superfaceai/one-sdk-js) for Node.js and with an existing [use-case](./reference//glossary.md#use-case). Let's say, you want to see what repositories Superface has on GitHub.

Install [Node.js](https://nodejs.org/en/download/) and create a new project:
Install [Node.js](https://nodejs.org/en/download/) and create a new project with [OneSDK](https://github.com/superfaceai/one-sdk-js):

```shell
mkdir my_project
cd my_project
npm init -y
npm install --save @superfaceai/one-sdk
```

Install [OneSDK](https://github.com/superfaceai/one-sdk-js) and configure [VCS User Repositories](https://superface.ai/vcs/user-repos) profile:
Install `vcs/user-repos` [profile](./reference/glossary#profile) and configure `GitHub` as a [provider](./reference/glossary#provider):

```shell
npx @superfaceai/cli install vcs/user-repos --providers github
Expand Down