Skip to content

Commit

Permalink
Docs and other updates for moving to the toolbox org (#35)
Browse files Browse the repository at this point in the history
* docs???

* update README with docs link; update LICENSE

* npm package move, no longer under @eritbh
  • Loading branch information
eritbh authored Jun 9, 2023
1 parent a0729ce commit 56e08b1
Show file tree
Hide file tree
Showing 8 changed files with 233 additions and 10 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Release documentation
on:
push:
tags:
- "v*"
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v2
- uses: actions/configure-pages@v3
- run: npm ci
- run: npm run docs
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v1
with:
path: docs/

# Deployment job
deploy:
environment:
name: docs
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ node_modules
.vscode
.nyc_output
dist

docs
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 eritbh
Copyright (c) 2023 the toolbox team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# toolbox-devvit [![npm version](https://img.shields.io/npm/v/@eritbh/toolbox-devvit.svg)](https://www.npmjs.com/package/@eritbh/toolbox-devvit)
# toolbox-devvit [![npm version](https://img.shields.io/npm/v/toolbox-devvit.svg)](https://www.npmjs.com/package/toolbox-devvit)

Helpers for working with /r/toolbox data from Devvit community apps.
Helpers for working with /r/toolbox data from Devvit community apps. [Read the documentation.](https://toolbox-team.github.io/toolbox-devvit/)

## Installation

```bash
npm install --production @eritbh/toolbox-devvit
npm install --production toolbox-devvit
```

## Usage Example

```ts
import {Devvit, RedditAPIClient, Context} from '@devvit/public-api';
import {ToolboxClient} from '@eritbh/toolbox-devvit';
import {ToolboxClient} from 'toolbox-devvit';

const reddit = new RedditAPIClient();
const toolbox = new ToolboxClient(reddit);
Expand Down Expand Up @@ -42,4 +42,4 @@ export default Devvit;

## License

[MIT © eritbh](/LICENSE)
[MIT © the toolbox team](/LICENSE)
184 changes: 182 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 56e08b1

Please sign in to comment.