From 84edbf6557289b7c8b60763aef9e9815d21d7a8b Mon Sep 17 00:00:00 2001 From: Paul Date: Fri, 30 Jul 2021 11:19:30 +0100 Subject: [PATCH] Publish API. --- README.md | 16 +++++++++++++++- package.json | 6 ++++-- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0e5bae3..3e4ffc7 100644 --- a/README.md +++ b/README.md @@ -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'); diff --git a/package.json b/package.json index e978547..2567011 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,12 @@ { - "name": "api", + "name": "revolt-api", "version": "0.5.1-alpha.10", + "description": "Revolt API typings", "main": "dist/index.js", "type": "module", + "homepage": "https://developers.revolt.chat", "repository": "https://gitlab.insrt.uk/revolt/api.git", - "author": "Paul ", + "author": "Paul Makles ", "license": "MIT", "scripts": { "build:generator": "tsc",