Publish API.

This commit is contained in:
Paul
2021-07-30 11:19:30 +01:00
parent 64603c1b42
commit 84edbf6557
2 changed files with 19 additions and 3 deletions
+15 -1
View File
@@ -1,5 +1,17 @@
# Revolt API
![revolt-api](https://img.shields.io/npm/v/revolt-api)
This package contains typings for objects in the [Revolt API](https://developers.revolt.chat/api/) and code for generating the OpenAPI specification.
For most cases, if not all, you should only be concerned with `revolt-api/types`.
### Example Usage
```typescript
import type { User } from 'revolt-api/types/Users';
```
### Commit Style
If publishing a new version of the spec, the first line should always be the API version.
@@ -10,6 +22,8 @@ Commit description.
Line 2.
```
If you are creating new changes for a PR, don't include any version!
For any subsequent lines, prepend the relevant text:
Prefix | Description
@@ -28,7 +42,7 @@ Add new prefixes to this list as necessary.
For faster compile times when working on API routes, comment out the categories you don't care about.
```ts
// src/routes/index.ts
/// src/routes/index.ts
export async function load() {
// await import('./core.js');
// await import('./users.js');