sneak/codenamegenerator
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Jeffrey Paul 2019-10-18 23:58:01 -07:00
parent f507467c14
commit 55f5bf335e
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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, I have intentionally excluded words that are long, confusing, hard to spell,
as well as occupations, animal names with negative connotations, and some as well as occupations, animal names with negative connotations, and some
foods and body parts in an attempt to avoid randomly generating negative, foods and body parts in an attempt to avoid randomly generating negative,
threatening, or disgusting code names. threatening, or disgusting code names.
# Run
Clone the repo, then run `PYTHONPATH=. python3 bin/server` inside it.
# Demo # Demo
A version should be running (free tier, be patient) at [https://codename-sneak-cloud.herokuapp.com](https://codename-sneak-cloud.herokuapp.com/). 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) names-generator](https://github.com/moby/moby/blob/master/pkg/namesgenerator/names-generator.go)
* [Generate-Codename (perl, 2011)](https://github.com/sneak/Generate-Codename) * [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 # Author
Jeffrey Paul <sneak@sneak.berlin> Jeffrey Paul <sneak@sneak.berlin>