diff --git a/.env b/.env.example similarity index 100% rename from .env rename to .env.example diff --git a/.gitignore b/.gitignore index 6797eb8..8ded7e3 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,7 @@ yarn-error.log # Platform specific .DS_Store + +# Sensitive file +.env* +!.env.example \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..591ad11 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 OnePixell + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 42454bd..9d6b87d 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,13 @@ git clone https://github.com/onepixell/base-bot.git cd base-bot ``` -**2. Install dependencies** +**2. Configure your env** +```bash +cp .env.example .env +nano .env +``` + +**3. Install dependencies** ```bash npm install ``` @@ -78,4 +84,4 @@ During development, plugins are stored in the `workspace/` directory. 4. Keep the bot running! Modify your code and save. Your changes will apply instantly via the **hot-reloading** system. ## 📜 License -Distributed under the MIT License. See `LICENSE` for more information. +Distributed under the MIT License. See [LICENSE](https://github.com/onepixell/base-bot/blob/main/LICENSE) for more information.