PigeonProtocolConsortium/Pigeon-Ruby
PigeonProtocolConsortium
/
Pigeon-Ruby
3
1
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Update README

This commit is contained in:
Netscape Navigator 2020-05-13 07:50:42 -05:00
parent 5d04457ddb
commit 77fbeeb4ab
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -46,18 +46,14 @@ See `kitchen_sink.sh` examples.
# Current Status
- [X] Create a contact email for project outsiders (and maybe a developer email list?)
- [X] Update README.md
- [X] Update Ruby API docs
- [X] Update blobs spec to clear out blob folder every time it runs.
- [ ] Oops, `lipmaa` field needs to be a hash, not an integer!
- [ ] Change `@`, `%`, `&` to `feed.`, `mesg.`, `blob.`, respectively. Better readability, easier onboarding, URL friendly.
- [ ] Change draft and message templates to render headers in this order: `author`, `prev`, `lipmaa`, `depth`, `kind`.
- [ ] Make location of blob folder configurable?
- [ ] Update Dev docs in protocol spec to reflect changes to `lipmaa` header.
- [ ] Update spec document CLI usage examples to reflect API changes in 2020.
- [X] Oops, `lipmaa` field needs to be a hash, not an integer!
- [ ] BUG: Keys that start with a carriage return (`\n`) freeze tokenizer.
- [ ] Convert literals to constants, remove unused locals, reduce duplication, run linter.
- [ ] Change message templates to render headers in this order: `author`, `prev`, `lipmaa`, `depth`, `kind`.
- [ ] Make location of blob folder configurable?
- [ ] Change `@`, `%`, `&` to `feed.`, `mesg.`, `blob.`, respectively. Better readability, easier onboarding, URL friendly.
- [ ] Update Dev docs in protocol spec to reflect changes to `lipmaa` header.
- [ ] Update spec document CLI usage examples to reflect API changes in 2020.
- [ ] 100% class / module documentation
- [ ] Run a [terminology extraction tool](https://www.visualthesaurus.com/vocabgrabber/#) on the documentation and write a glossary of terms.
- [ ] Publish to RubyGems
@ -83,3 +79,7 @@ See `kitchen_sink.sh` examples.
- [ ] Ability to add map/reduce plugins to support custom indices?
- [ ] Ability to add a blob in one swoop using File objects and `Message#[]=`, maybe?
- [ ] Bundling via [Optar](http://ronja.twibright.com/optar/) or [Colorsafe](https://github.com/colorsafe/colorsafe)
- [ ] Ability to add map/reduce plugins to support custom indices?
- [ ] Ability to add a blob in one swoop using File objects and `Message#[]=`, maybe?
- [ ] Bundling via [Optar](http://ronja.twibright.com/optar/) or [Colorsafe](https://github.com/colorsafe/colorsafe)