From 55f5bf335e54c911f938868b1b8b001fbfecbd34 Mon Sep 17 00:00:00 2001 From: Jeffrey Paul Date: Fri, 18 Oct 2019 23:58:01 -0700 Subject: [PATCH] update readme --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 450e068..78bf22f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ -# generate-codename +# codenamegenerator -This software generates random codenames for projects. +This is a python module that generates random codenames for projects. + +A basic command, as well as a simple HTTP API server, are included. I have intentionally excluded words that are long, confusing, hard to spell, as well as occupations, animal names with negative connotations, and some foods and body parts in an attempt to avoid randomly generating negative, threatening, or disgusting code names. +# Run + +Clone the repo, then run `PYTHONPATH=. python3 bin/server` inside it. + # Demo A version should be running (free tier, be patient) at [https://codename-sneak-cloud.herokuapp.com](https://codename-sneak-cloud.herokuapp.com/). @@ -17,6 +23,12 @@ A version should be running (free tier, be patient) at [https://codename-sneak-c names-generator](https://github.com/moby/moby/blob/master/pkg/namesgenerator/names-generator.go) * [Generate-Codename (perl, 2011)](https://github.com/sneak/Generate-Codename) +# Invitation + +You are invited to contribute to this repository. Pull requests that +introduce additional words for the lists are welcome, but please keep it +simple. + # Author Jeffrey Paul <sneak@sneak.berlin>