Move project management out to a separate file

This commit is contained in:
Eric Budd 2018-03-31 19:08:09 -04:00
parent 92b4586422
commit eee023dab3
2 changed files with 56 additions and 52 deletions

56
TODO.md Normal file
View File

@ -0,0 +1,56 @@
# Epics
## MVP: Complete!
## Reading/Status: Complete!
## Editing/Deleting: In Progress
## Documentation: In Progress
* Add command-line options to README
* Flesh out technical sections
# Tech debt:
* Flesh out tests
* Add integration tests
* Create Struct to firm up message payload
* Let Message initialization accept params as a hash
* Add check for message file format version
# Refactoring
* Split helptext into separate file?
# Features:
* Change listing to show last updated timestamp, instead of thread creation timestamp
* Message deletion
* Message editing
* Gracefully handle bad message files
* Add read-only mode if user doesn't want/can't have message file
* Add user muting (~/.iris.muted)
* Add message editing
* JSON API mode
* Check message file size before loading, to prevent giant files from bombing the system.
* Add stats to interactive interface
# Fancify interface:
* Add (read/unread) counts to topic line
* Add reader/user count to stats
* Gracefully handle attempt to "r 1 message"
* Highlight names for readability
* Readline.completion_proc for tab completion
* Pagination?
* Add optional title for topics
* Add message when no topics are found
* Add message troubleshooting tool, for deep data dive
* Add option to skip color
# Icebox
* ncurses client
* customizable prompt
* MOTD
* Add to default startup script to display read count
* Common message file location for the security-conscious
* JSON -> SSI -> Javascript webreader
# Completed
* Make all output WIDTH-aware
* Add color
* Add full message corpus dump for backup/debugging
* Add startup enviro health check

52
iris.rb
View File

@ -1,56 +1,4 @@
#!/usr/bin/env ruby
# MVP: Complete!
# Reading/Status: Complete!
#
# Documentation
# TODO: Add command-line options to README
# TODO: Flesh out technical sections
#
# Tech debt:
# TODO: Refactor
# TODO: Flesh out tests
# TODO: Add integration tests
# TODO: Split helptext into separate file?
# TODO: Make all output WIDTH-aware
# TODO: Create struct to firm up message payload
# TODO: Let Message initialization accept params as a hash
# TODO: Add checking for message file format version
# TODO: Check file ownership of message file
#
# Features:
# TODO: Change listing to show last updated timestamp, instead of thread creation timestamp
# TODO: Add full message corpus dump for backup/debugging
# TODO: Gracefully handle bad message files
# TODO: Add read-only mode if user doesn't want/can't have message file
# TODO: Add user muting (~/.iris.muted)
# TODO: Message deletion
# TODO: Message editing
# TODO: Add startup enviro health check
# TODO: Add message editing
# TODO: JSON API mode
# TODO: Check message file size before loading, to prevent giant files from bombing the system.
#
# Fancify interface:
# TODO: Add (read/unread) counts to topic line
# TODO: Add reader/user count to stats
# TODO: Gracefully handle attempt to "r 1 message"
# TODO: Highlight names for readability
# TODO: Readline.completion_proc for tab completion
# TODO: Pagination?
# TODO: Add optional title for topics
# TODO: Add message when no topics are found
# TODO: Add message troubleshooting tool, for deep data dive
# TODO: Add color
# TODO: Add option to skip color
#
# Later/Maybe:
# * ncurses client
# * customizable prompt
# * MOTD
# * Add to default startup script to display read count
# * Common message file location for the security-conscious
require 'time'
require 'base64'
require 'digest'