aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2017-07-16 01:29:42 -0700
committerbnewbold <bnewbold@robocracy.org>2017-07-16 01:29:42 -0700
commit34a7f24b05122484e26d049df50a2ed40424e26a (patch)
tree8e4adc5b19b0e4179da6674dad3c0fdd9b44d3c0
parentf26ca45041589ade754331b63cc998fb97f5f597 (diff)
downloaddivergence-34a7f24b05122484e26d049df50a2ed40424e26a.zip
divergence-34a7f24b05122484e26d049df50a2ed40424e26a.tar.gz
tweak README and TODO
-rw-r--r--README.md10
-rw-r--r--TODO.md6
2 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index 26191c3..5e43752 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-A simple python script for uploading markdown files to Confluence (a
-proprietary wiki system). If you find yourself needing to publish documentation
-to Confluence at work, but wish that instead you could just write markdown and
-keep it versioned in git instead of contending with browser-mangling javascript
-and pull-down menus, then this tool is for you!
+`divergence` is a simple python script for uploading markdown files to
+Confluence (a proprietary wiki system). If you find yourself needing to publish
+documentation to Confluence at work, but wish that instead you could just write
+markdown and keep it versioned in git instead of contending with
+browser-mangling javascript and pull-down menus, then this tool is for you!
This is crude and one-way: there is no mechanism for synchronizing or retaining
edits made by peers, won't look the way you want it to, there are no unittests,
diff --git a/TODO.md b/TODO.md
index ce685c0..dd3b263 100644
--- a/TODO.md
+++ b/TODO.md
@@ -4,9 +4,9 @@ TODO:
- have space default to user home
- update checking doesn't actually work
- fuzzy page title matching bug
-- optional header
-- optional table of contents
-- force update flag
+- optional header (flag)
+- optional table of contents (flag)
+- "force update" (flag)
Nice to have, but unlikely to be implemented:
- more than just markdown (restructured text, html, etc)