Skip to content

Commit c4be6f0

Browse files
committed
docs: update readme
1 parent b5b3a64 commit c4be6f0

1 file changed

Lines changed: 9 additions & 13 deletions

File tree

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Fast and simple package to get and create bins from [sourcebin](https://sourceb.
44

55
# Requirements
66

7-
Node >= 22.13
7+
Node `>=22.13`
88

9-
# Get a bin
9+
## Getting
1010

1111
`get(options)`
1212

@@ -16,14 +16,14 @@ import { get } from 'sourcebin';
1616
const bin = await get({ key: 'qXO2NVhRc6' });
1717
```
1818

19-
## Options
19+
### Options
2020

2121
| Option | Description | Default | Required |
2222
| -------------- | --------------------------------- | ------- | -------- |
2323
| `key` | The key to get | n/a ||
2424
| `fetchContent` | Should the bin content be fetched | `true` ||
2525

26-
# Create a bin
26+
## Creating
2727

2828
`create(options)`
2929

@@ -42,24 +42,24 @@ const bin = await create({
4242
});
4343
```
4444

45-
## Options
45+
### Options
4646

4747
| Option | Description | Required |
4848
| ------------- | ---------------------- | -------- |
4949
| `title` | Title of the bin ||
5050
| `description` | Description of the bin ||
5151
| `files` | Bin files - see below ||
5252

53-
### File Options
53+
#### File Options
5454

5555
| Option | Description | Default | Required |
5656
| ---------- | -------------------------------- | ------- | -------- |
5757
| `content` | Contents of the file | n/a ||
5858
| `language` | What language should the file be | `text` ||
5959

60-
# Url Helper
60+
## URL Helper
6161

62-
If you want to get information about a bin try the `url` function.
62+
Constructs the long and short Sourcebin URL for a key.
6363

6464
```js
6565
const urlData = url('iQznILdZRP');
@@ -83,7 +83,7 @@ This returns an object that looks like:
8383

8484
- ## Multiple files in one bin
8585

86-
This is not currently possible with this wrapper as sourcebin doesn't have a token system for authentication, only pro users are able to have multiple files in one bin. This may come in the future
86+
Only Sourcebin Pro users are able to have multiple files per bin, and since there is no non-hacky way to authenticate this library doesn't currently support multiple files. We can add support in the future if they add a way to authenticate with the API.
8787

8888
- ## Migrate from v5 to v6
8989

@@ -92,7 +92,3 @@ This returns an object that looks like:
9292
- ## Migrate from v4 to v5
9393

9494
[See the README from a v5 release](https://github.com/ghostdevv/sourcebin/blob/611318be1b4aff17d19f80df20b73908ddf53376/README.md#migrate-from-v4-to-v5)
95-
96-
# Support
97-
98-
- Create a issue on the [github](https://github.com/ghostdevv/sourcebin/issues/new)

0 commit comments

Comments
 (0)