From d5cf9a84f50cf0a329cb07788262ea111d1d8e87 Mon Sep 17 00:00:00 2001 From: Aine Date: Mon, 22 Aug 2022 19:11:00 +0300 Subject: [PATCH] update readme and license --- LICENSE.md | 53 ----------------------------------------------------- README.md | 17 ++++++----------- 2 files changed, 6 insertions(+), 64 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index f288702..810fce6 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -619,56 +619,3 @@ Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - 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 . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/README.md b/README.md index b80f7c0..ce3675b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# Postmoogle +# Postmoogle [![Matrix](https://img.shields.io/matrix/postmoogle:etke.cc?logo=matrix&style=for-the-badge)](https://matrix.to/#/#postmoogle:etke.cc)[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/etkecc) [![coverage report](https://gitlab.com/etke.cc/postmoogle/badges/main/coverage.svg)](https://gitlab.com/etke.cc/postmoogle/-/commits/main) [![Go Report Card](https://goreportcard.com/badge/gitlab.com/etke.cc/postmoogle)](https://goreportcard.com/report/gitlab.com/etke.cc/postmoogle) [![Go Reference](https://pkg.go.dev/badge/gitlab.com/etke.cc/postmoogle.svg)](https://pkg.go.dev/gitlab.com/etke.cc/postmoogle) + +> [more about that name](https://finalfantasy.fandom.com/wiki/The_Little_Postmoogle_That_Could) An Email to Matrix bridge @@ -26,7 +28,7 @@ env vars ### mandatory * **POSTMOOGLE_HOMESERVER** - homeserver url, eg: `https://matrix.example.com` -* **POSTMOOGLE_LOGIN** - user login/localpart, eg: `scheduler` +* **POSTMOOGLE_LOGIN** - user login/localpart, eg: `moogle` * **POSTMOOGLE_PASSWORD** - user password * **POSTMOOGLE_DOMAIN** - SMTP domain to listen for new emails * **POSTMOOGLE_PORT** - SMTP port to listen for new emails @@ -41,13 +43,6 @@ env vars You can find default values in [config/defaults.go](config/defaults.go) -## Development +## Where to get -### Prerequisites - -* [ssmtp](https://wiki.archlinux.org/title/SSMTP) -* configured mailbox `test@localhost` - -### Testing - -Run `send` script of the `e2e` dir with example emails +[docker registry](https://gitlab.com/etke.cc/postmoogle/container_registry), [etke.cc](https://etke.cc)