Documentation (#11)

* add gnu gpl 3.0 or high license
* Update README.md

README.md

@@ -1,5 +1,5 @@
 <h1 align="center">
-    Twitch Hubble Bot
+    Hub Reply Bot
 </h1>
 <details>
   <summary>🇺🇸 English version</summary>
@@ -71,20 +71,26 @@
 
   <h2 id="objetivos" > 🎯 Objetivos </h2>
 
-  Uma breve descrição sobre o projeto e como ele funciona
+  Um simples bot com respostas aleatórias para twitch e discord.
+
+  Utiliza marcações em yaml, facilitando a adição de novos comandos.
 
   <h2 id="tecnologia"> 🛠 Tecnologias </h2>
 
   As ferramentas utilizadas na construção do projeto foram:
 
-  - [Name Tech](UrlForTheTech)
+  - [TypeScript](https://www.typescriptlang.org)
+  - [Yaml](https://yaml.org)
+  - [tmi.js](https://tmijs.com)
+  - [discord.js](https://discord.js.org)
 
   <h2 id="usos" > 👷 Como usar? </h2>
 
-  - Tecnologias necessárias para rodar localmente.
+  - Você precisa de node e npm instalados em sua maquina.
 
   ```bash
-  # Comandos usados para iniciar o projeto.
+  $ npm install
+  $ npm start
   ```
 
   <h2 id="contribuicao"> 🤝 Contribuições </h2>
@@ -94,7 +100,7 @@
 
   <h2 id="autor"> 💻 Autor </h2>
 
-  By Name ❤
+  By Name RodrigoDornelles ❤
 
   <h2 id="licenca"> 📝 Licença </h2>
 

package.json

@@ -1,22 +1,22 @@
 {
     "name": "reply-hubble-bot",
     "version": "1.0.0",
-    "description": "hybrid chatbot that replies twitch and discord messages",
+    "description": "Simple random reply chatbot for twitch and discord.",
     "main": "dist/index.js",
     "scripts": {
         "start": "node .",
         "build": "tsc"
     },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/ahub-tech/twitch-hubble-bot"
+        "url": "git+https://github.com/aHub-Tech/hub-reply-bot"
     },
-    "author": "Rodrigo Dornelles",
+    "author": "RodrigoDornelles",
     "license": "GPL-3.0-or-later",
     "bugs": {
-        "url": "https://github.com/ahub-tech/twitch-hubble-bot/issues"
+        "url": "https://github.com/aHub-Tech/hub-reply-bot/issues"
     },
-    "homepage": "https://github.com/ahub-tech/twitch-hubble-bot#readme",
+    "homepage": "https://github.com/aHub-Tech/hub-reply-bot#readme",
     "dependencies": {
         "discord.js": "^13.1.0",
         "dotenv": "^10.0.0",

src/api-discord.ts

@@ -1,3 +1,21 @@
+/**
+ * Simple random reply chatbot for twitch and discord. 
+ * Copyright (C) 2021  RodrigoDornelles
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
 import { Client, Intents } from 'discord.js';
 import { cmd, mention, DiscordEvent } from './utils'
 import { env } from './env'

src/api-twitch.ts

@@ -1,3 +1,21 @@
+/**
+ * Simple random reply chatbot for twitch and discord. 
+ * Copyright (C) 2021  RodrigoDornelles
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
 import { Client } from 'tmi.js'
 import { chunk, cmd, mention, TwitchEvent, bypassAntiSpam } from './utils';
 import { env } from './env'

src/env.ts

@@ -1,3 +1,20 @@
+/**
+ * Simple random reply chatbot for twitch and discord. 
+ * Copyright (C) 2021  RodrigoDornelles
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
 
 import { EnvType, load } from 'ts-dotenv';
 import { config } from 'dotenv';

src/fetch-commands.ts

@@ -1,3 +1,21 @@
+/**
+ * Simple random reply chatbot for twitch and discord. 
+ * Copyright (C) 2021  RodrigoDornelles
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
 import fs from 'fs'
 import YAML from 'yaml'
 

src/index.ts

@@ -1,3 +1,21 @@
+/**
+ * Simple random reply chatbot for twitch and discord. 
+ * Copyright (C) 2021  RodrigoDornelles
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
 import { choice } from './utils';
 import { env, loadEnv } from './env'
 import fetchCommands from './fetch-commands'

src/utils.ts

@@ -1,3 +1,21 @@
+/**
+ * Simple random reply chatbot for twitch and discord. 
+ * Copyright (C) 2021  RodrigoDornelles
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
 import { env } from './env'
 
 export function choice<Item = unknown>(arr?: Item[] | null) {