From 0a0b91363ca180cf84d569edb13358b28f9e9f7d Mon Sep 17 00:00:00 2001 From: devnote-dev Date: Sun, 13 Nov 2022 17:22:29 +0000 Subject: [PATCH] chore(generic): update generic readmes --- README.md | 2 ++ generic/README.md | 18 +++++++++--------- generic/dart/README.md | 4 ++-- generic/deno/README.md | 4 ++-- generic/golang/README.md | 6 +++--- generic/java/README.md | 4 ++-- generic/lua/luvit/README.md | 4 ++-- generic/nodejs/README.md | 4 ++-- generic/nodemon/README.md | 4 ++-- generic/python/README.md | 4 ++-- generic/rust/README.md | 4 ++-- 11 files changed, 30 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 0fdb648b..f258d3bc 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ If you are reading this it looks like you are looking to add an egg to your serv [Discord](/bots/discord) +**Note:** these are actual Discord bot eggs, NOT language eggs. The old language eggs (discord-js-generic, discord-py-generic, etc) have been moved to the [generic languages section](#generic-languages). + * [ATL Bot](/bots/discord/atlbot) Node JS * [Bastion](/bots/discord/bastion) Node JS * [CorpBot](/bots/discord/corpbot) Python diff --git a/generic/README.md b/generic/README.md index 95fcd1e4..22a8983a 100644 --- a/generic/README.md +++ b/generic/README.md @@ -3,44 +3,44 @@ ### [Dart](dart) [dart](https://dart.dev/) -A generic dart egg +A generic Dart language egg ### [Deno](deno) [deno](https://deno.land/) -A generic deno egg +A generic Deno language egg ### [Golang](golang) [golang](https://go.dev/) -A generic go egg +A generic Go language egg ### [Java](java) [java](https://www.java.com/en/) -A generic java egg +A generic Java (and Kotlin) language egg ### [Lua](lua) [lua](https://www.lua.org/) -A generic luvit/lua egg +A generic Lua (Luvit) language egg ### [Node JS](nodejs) [nodejs](https://nodejs.org) -A generic node.js egg +A generic Node.JS egg ### [nodemon](nodemon) [nodemon](https://nodemon.io/) -A nodemon javascript egg for running and automatically restarting the node application when file changes in the directory are detected +A nodemon JavaScript and TypeScript language egg for running and automatically restarting the node application when file changes in the directory are detected ### [Python](python) [python](https://www.python.org/) -A generic python egg +A generic Python language egg ### [Rust](python) [rust](https://www.rust-lang.org/) -A generic rust egg +A generic Rust language egg diff --git a/generic/dart/README.md b/generic/dart/README.md index d4ca08c7..2148da82 100644 --- a/generic/dart/README.md +++ b/generic/dart/README.md @@ -1,6 +1,6 @@ -# dart generic +# Dart Language Generic -This egg is designed to run any generic Dart application, allowing users to pull their own Dart discord bot from a Github repository. +This egg is designed to run any generic Dart application, allowing users to pull their own Dart source code from a Github repository. There is an option to allow a user to upload their own files to run a bot. diff --git a/generic/deno/README.md b/generic/deno/README.md index 4e47367d..657954d2 100644 --- a/generic/deno/README.md +++ b/generic/deno/README.md @@ -1,8 +1,8 @@ -# Deno generic +# Deno - JavaScript & TypeScript Generic ## From their [site](https://deno.land/) -This egg is designed to run any generic Deno application, allowing users to pull their own Deno discord bot from a Github repository. +This egg is designed to run any generic Deno application, allowing users to pull their own Deno source code from a Github repository. There is an option to allow a user to upload their own files to run a server. diff --git a/generic/golang/README.md b/generic/golang/README.md index 9aaf837b..39942afe 100644 --- a/generic/golang/README.md +++ b/generic/golang/README.md @@ -1,12 +1,12 @@ -# discordgo generic +# Go Language Generic -This egg is designed to run any generic Golang application, allowing users to pull their own Golang discord bot from a Github repository. +This egg is designed to run any generic Go application, allowing users to pull their own Go source code from a Github repository. The startup configs and commands may need changing to actually function properly. Users cannot upload their own code as this is built to build the resulting bot. -`GO_PACKAGE` is the variable for the go repo i.e. `github.com/aurieh/ddg-ng` +`GO_PACKAGE` is the variable for the Go repo i.e. `github.com/aurieh/ddg-ng` `EXECUTABLE` is the variable for the executable that is built i.e. `ddg-ng` ## Configuration diff --git a/generic/java/README.md b/generic/java/README.md index 57d230ed..5f4e909c 100644 --- a/generic/java/README.md +++ b/generic/java/README.md @@ -1,6 +1,6 @@ -# discord.java generic +# Java Language Generic -This egg is designed to run any generic Java application, allowing users to pull their own Java discord bot from a Github repository. +This egg is designed to run any generic Java application, allowing users to pull their own Java source code from a Github repository. This egg is also compatible with Kotin. There is an option to allow a user to upload their own files to run a bot. diff --git a/generic/lua/luvit/README.md b/generic/lua/luvit/README.md index 0991c90d..f5cc7dd1 100644 --- a/generic/lua/luvit/README.md +++ b/generic/lua/luvit/README.md @@ -1,6 +1,6 @@ -# luvit generic +# Lua (Luvit) Language Generic -This egg was designed to allow a user to pull their own lua code from a repo and run it with luvit. +This egg was designed to allow a user to pull their own Lua source code from a repo and run it with Luvit. There is an option to allow a user to upload their own files to run an app. diff --git a/generic/nodejs/README.md b/generic/nodejs/README.md index 1d7a903d..bcb21c56 100644 --- a/generic/nodejs/README.md +++ b/generic/nodejs/README.md @@ -1,6 +1,6 @@ -# discord.js generic +# JavaScript Language Generic -This egg is designed to run any generic Javascript application, allowing users to pull their own javascript discord bot from a Github repository. +This egg is designed to run any generic JavaScript application, allowing users to pull their own JavaScript source code from a Github repository. There is an option to allow a user to upload their own files to run a bot. diff --git a/generic/nodemon/README.md b/generic/nodemon/README.md index c50d7e1a..0a8331c2 100644 --- a/generic/nodemon/README.md +++ b/generic/nodemon/README.md @@ -1,10 +1,10 @@ -# nodemon.js +# Nodemon (JavaScript & TypeScript) Tired of manually restarting your bot? Nodemon will do it by itself. Nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected. Nodemon does not require any additional changes to your code or method of development. -This egg is designed to run any generic Javascript application, allowing users to pull their own javascript discord bot from a Github repository. +This egg is designed to run any generic Javascript application, allowing users to pull their own JavaScript or TypeScript source code from a Github repository. There is an option to allow a user to upload their own files to run a bot. diff --git a/generic/python/README.md b/generic/python/README.md index 2a823146..8b1f73d5 100644 --- a/generic/python/README.md +++ b/generic/python/README.md @@ -1,6 +1,6 @@ -# discord.py generic +# Python Language Generic -This egg is designed to run any generic Python application, allowing users to pull their own Python discord bot from a Github repository. +This egg is designed to run any generic Python application, allowing users to pull their own Python source code from a Github repository. There is an option to allow a user to upload their own files to run a bot. diff --git a/generic/rust/README.md b/generic/rust/README.md index 93397da4..db9a836d 100644 --- a/generic/rust/README.md +++ b/generic/rust/README.md @@ -1,6 +1,6 @@ -# rust generic +# Rust Language Generic -This egg is designed to run any generic Rust application with cargo, allowing users to pull their own Rust discord bot from a GitHub repository. +This egg is designed to run any generic Rust application with Cargo, allowing users to pull their own Rust source code from a GitHub repository. ## Configuration