diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5a55491..5d6ce99 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -8,6 +8,7 @@ on: jobs: deploy: runs-on: ubuntu-latest + steps: - name: Checkout the Repository uses: actions/checkout@v2 diff --git a/.prettierignore b/.prettierignore index f65ef01..19413e7 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,3 +1,4 @@ dist/ typings/ docs/ +.github/workflows diff --git a/README.md b/README.md index 4ca88ae..cb4ce98 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,63 @@ # dogehq -A wrapper for the DogeHouse Kebab API Client. +> API Wrapper for [@dogehouse/kebab](https://npmjs.com/package/@dogehouse/kebab) + +
+ +## Features + +- Actually maintained +- Supports bot creation +- Uses async/await +- Uses [@discordjs/collection](https://npmjs.com/package/@discordjs/collection) to store users, rooms, etc. +- Typescript support + +## Install + +```bash +yarn add dogehq +``` + +## Documentation + +https://shukaaku.github.io/dogehq + +## Support + +https://discord.gg/ZrrAQ3HAdK + +## Usage + +```js +const { Client } = require('dogehq'); + +const client = new Client(); + +client.on('ready', () => console.log(`Logged in as ${client.user.username} (${client.user.id}).`)); + +client.login('token', 'accessToken'); +``` + +## Contributing + +1. Fork it! +2. Create your feature branch: `git checkout -b my-new-feature` +3. Commit your changes: `git commit -am 'Add some feature'` +4. Push to the branch: `git push origin my-new-feature` +5. Submit a pull request :D + +## Author + +**dogehq** © [1chiSensei](https://github.com/1chiSensei), Released under the [Apache-2.0](https://github.com/Shukaaku/dogehq/blob/main/LICENSE) License.