Author: Pedro Lucas Porcellis <porcellis@eletrotupi.com>
all: improve grammar on readme and remove public instance mention
README.md | 24 +++++++++++-------------
diff --git a/README.md b/README.md index f776b3cf713c86ad483b85e79b820c013a0985de..2188cbb892f893cac8972aba4993eac06d685adf 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@ to potentially identify one. ## Data -There is two types of data here, `usernames` and `domains`, both available as a +There are two types of data here, `usernames` and `domains`, both available as a plain text file, each item on a new line. Usernames were initially sourced from -the Big-Blacklist. Domains are a combination of disposable emails and other -hand-picked items I found as sysadmin of [cirandas.net][cirandas]. +the Big-Blacklist. Domains combine disposable emails and other hand-picked items +I found as sysadmin of [cirandas.net][cirandas]. -We also offer some pretty simple awk scripts to process the raw data and spit -into two flavours: `json` and `yaml`. Generate them on using the `make(1)` -rules: +We also offer some simple awk scripts to process the raw data and spit into two +flavours: `json` and `yaml`. Generate them using the `make(1)` rules: + ```sh $ make # will invoke json and yaml @@ -22,18 +22,16 @@ ``` ## API -We also offer a pretty barebones API available at [antispam-api][antispam-api]. -Which you can host yourself if you want it. There's a public instance available -at [antispam.eletrotupi.com][public-instance]. +We also offer a pretty barebones API available at [antispam-api][]. You can host +an instance yourself if you want it, it's pretty simple. [cirandas]: https://git.eletrotupi.com/cirandas.net [antispam-api]: https://git.sr.ht/~porcellis/antispam-api -[public-instance]: https://antispam.eletrotupi.com ## Contribute -Please do! You can add more items sending a patch to the [mailing list][ml] or -to me [personally][personal]. If you think your domain was included as a +Please do! You can add more items by sending a patch to the [mailing list][ml] +or to me [personally][personal]. If you think your domain was included as a mistake, contact me too. [ml]: mailto:~porcellis/antispam@lists.sr.ht @@ -41,6 +39,6 @@ [personal]: mailto:porcellis@eletrotupi.com ## License -MIT License. Check [COPYING][copying] +MIT Licensed. Check [COPYING][copying] [copying]: ./COPYING