Browse Source

add README and LICENSE

master
bn4t 8 months ago
parent
commit
ab494de7e8
3 changed files with 51 additions and 0 deletions
  1. +21
    -0
      LICENSE.md
  2. +18
    -0
      README.md
  3. +12
    -0
      docker-compose.yml

+ 21
- 0
LICENSE.md View File

@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 bn4t

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.

+ 18
- 0
README.md View File

@@ -0,0 +1,18 @@
# Pleroma Release Bot
*A bot that toots out new Pleroma releases*

**Bot Account:** [@PleromaReleases](https://social.bn4t.me/PleromaReleases)

## Setup


1. Clone the repository and enter the directory: `git clone https://git.bn4t.me/bn4t/pleroma-release-bot.git
&& cd pleroma-release-bot`
2. Edit the environment variables in `docker-compose.yml`

3. Build the image and start the container: `docker-compose up --build -d`


## License

MIT

+ 12
- 0
docker-compose.yml View File

@@ -0,0 +1,12 @@
version: '2.2'

services:
release-bot:
build: .
image: pleroma-release-bot
environment:
- SERVER_URL=https://social.bn4t.me
- USERNAME=BotName
- PASSWORD=P4ssw0rd
restart: always


Loading…
Cancel
Save