diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a7e769 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +widdler +======= + +widdler is a single binary that serves up +[TiddlyWiki](https://tiddlywiki.com)s. + +It can be used to server existing wikis, or to create new ones. + +# Installation + +``` +go get -u suah.dev/widdler +``` + +# Running + +``` +widdler +``` + +# Creating a new TiddlyWiki + +Simply browse to the file name you wish to create. widdler will automatically +create the wiki file based off the current `empty.html` TiddlyWiki version. + +# Saving changes + +Simply hit the save button!