Skip to content

Commit

Permalink
chore(release): release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
1chiSensei committed Apr 27, 2021
1 parent 4c86f39 commit 70d3362
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:
jobs:
deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout the Repository
uses: actions/checkout@v2
Expand Down
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dist/
typings/
docs/
.github/workflows
62 changes: 61 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,63 @@
# dogehq

A wrapper for the DogeHouse Kebab API Client.
> API Wrapper for [@dogehouse/kebab](https://npmjs.com/package/@dogehouse/kebab)
<div align="center">
<p>
<a href="https://www.npmjs.com/package/dogehq"><img src="https://img.shields.io/npm/v/dogehq.svg?maxAge=3600" alt="NPM version" /></a>
<a href="https://www.npmjs.com/package/dogehq"><img src="https://img.shields.io/npm/dt/dogehq?maxAge=3600" alt="NPM downloads" /></a>
<a href="https://david-dm.org/Shukaaku/dogehq"><img src="https://david-dm.org/Shukaaku/dogehq/status.svg?maxAge=3600" alt="Dependencies" /></a>
</p>
<p>
<a href="https://nodei.co/npm/dogehq/"><img src="https://nodei.co/npm/dogehq.png?downloads=true&stars=true" alt="NPM info" /></a>
</p>
</div>

## 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.<br>
Authored and maintained by 1chiSensei.

> GitHub [@1chiSensei](https://github.com/1chiSensei)
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,9 @@
"typedoc": "^0.20.36",
"typedoc-vortex-theme": "^0.0.2",
"typescript": "^4.2.4"
}
},
"files": [
"dist",
"typings"
]
}

0 comments on commit 70d3362

Please sign in to comment.