Update docs

This commit is contained in:
Amish Shah
2016-08-30 14:56:33 +01:00
parent 4f41a86dd3
commit 39f969c777
3 changed files with 21 additions and 31 deletions

View File

@@ -0,0 +1,16 @@
<p align="center">
<a href="https://hydrabolt.github.io/discord.js">
<img alt="discord.js" src="http://i.imgur.com/sPOLh9y.png" width="546">
</a>
</p>
[![Build Status](https://travis-ci.org/hydrabolt/discord.js.svg)](https://travis-ci.org/hydrabolt/discord.js) [![Documentation Status](https://readthedocs.org/projects/discordjs/badge/?version=latest)](http://discordjs.readthedocs.org/en/latest/?badge=latest)
[![NPM](https://nodei.co/npm/discord.js.png?downloads=true&stars=true)](https://nodei.co/npm/discord.js/)
# Welcome!
Welcome to the discord.js rewrite documentation. The rewrite has taken a lot of time, but it should be much more
stable and performance-friendly than previous versions.
## Installation
`npm i --save hydrabolt/discord.js#indev-rewrite`

View File

@@ -1,33 +1,7 @@
const fs = require('fs');
module.exports = {
category: 'General',
name: 'Getting Started',
data:
`# Welcome!
discord.js is an easy-to-use and intuitive JavaScript library that wraps around the Discord API.
## Installation
To install discord.js from npm:
\`\`\`bash
npm i --save discord.js
\`\`\`
To install discord.js from the master branch:
\`\`\`bash
npm i --save hydrabolt/discord.js
\`\`\`
To install discord.js from the development branch:
\`\`\`bash
npm i --save hydrabolt/discord.js#indev
\`\`\`
To install discord.js from the rewrite branch:
\`\`\`bash
npm i --save hydrabolt/discord.js#indev-rewrite
\`\`\`
## Tutorials
LuckyEvie, a helper in the discord.js channel, has put together a great tutorial on getting to grips with discord.js.
It's worth a read and you can find it [here.](https://eslachance.gitbooks.io/discord-js-bot-guide/content/samples/selfbots,_the_awesomest_thing_in_the_universe.html)
`,
name: 'Welcome',
data: fs.readFileSync('./docs/custom/documents/getting_started.md').toString('utf-8'),
};

File diff suppressed because one or more lines are too long