-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update readme with first draft API
- Loading branch information
Showing
1 changed file
with
87 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,88 @@ | ||
# dribbblejs | ||
|
||
|
||
## Getting Started | ||
### Installation | ||
|
||
``` | ||
yarn add dribbblejs | ||
``` | ||
``` | ||
npm install dribbblejs | ||
``` | ||
|
||
### Usage | ||
|
||
```ts | ||
import { Dribbble } from "dribbblejs"; | ||
|
||
const dribbble = new Dribbble({ | ||
authToken: "xxxxxxxx" | ||
}); | ||
``` | ||
|
||
## API | ||
|
||
### User | ||
|
||
#### Get the authenticated user | ||
```ts | ||
dribbble.user.get() | ||
``` | ||
|
||
### Projects | ||
|
||
#### Fetching a list of projects | ||
```ts | ||
dribbble.projects.list() | ||
``` | ||
#### Create a project | ||
```ts | ||
dribbble.projects.create() | ||
``` | ||
#### Update a project | ||
```ts | ||
dribbble.projects.update() | ||
``` | ||
#### Delete a project | ||
```ts | ||
dribbble.projects.delete() | ||
``` | ||
|
||
### Shots | ||
|
||
#### Fetching a list of shots | ||
```ts | ||
dribbble.shots.list() | ||
``` | ||
#### Get a shot | ||
```ts | ||
dribbble.shots.get() | ||
``` | ||
#### Create a shot | ||
```ts | ||
dribbble.shots.create() | ||
``` | ||
#### Update a shot | ||
```ts | ||
dribbble.shots.update() | ||
``` | ||
#### Delete a shot | ||
```ts | ||
dribbble.shots.delete() | ||
``` | ||
|
||
### Attachments | ||
|
||
#### Create an attachment for a shot | ||
```ts | ||
dribbble.attachments.create() | ||
``` | ||
|
||
#### Delete an attachment for a shot | ||
```ts | ||
dribbble.attachments.create() | ||
``` | ||
|
||
--- | ||
|
||
###### MIT Licensed |