Skip to content

Commit

Permalink
chore: update readme with first draft API
Browse files Browse the repository at this point in the history
  • Loading branch information
animify authored Feb 20, 2020
1 parent 5d2767e commit ce6dfb3
Showing 1 changed file with 87 additions and 1 deletion.
88 changes: 87 additions & 1 deletion README.md
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

0 comments on commit ce6dfb3

Please sign in to comment.