diff --git a/README.md b/README.md index c6089a8..49109f2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - Welcome to Smeagol! + # Welcome to Smeagol! Smeagol is a simple Wiki engine inspired by [Gollum](https://github.com/gollum/gollum/wiki). Gollum is a Wiki engine written in Ruby, which uses a number of simple text formats including [Markdown](http://daringfireball.net/projects/markdown/), which uses [Git](http://git-scm.com/) to provide versioning and backup. I needed a new Wiki for a project and thought Gollum would be ideal - but unfortunately it doesn't provide user authentication, which I needed, and it was simpler for me to reimplement the bits I did need in Clojure than to modify Gollum. @@ -18,11 +18,12 @@ that is to say, the username is a keyword and the corresponding password is a st ## Todo -* Git integration! Smeagol doesn't have any inbuilt versioning or backup mechanism; it's intended that Git will be used as that mechanism. But it isn't implemented yet. -* Image (and other media) upload. -* Improved security. -* Mechanism to add users through the user interface. -* Mechanism to change passwords through the user interface. +* Git integration! Smeagol doesn't have any inbuilt versioning or backup mechanism; it's intended that Git will be used as that mechanism. But it isn't implemented yet; +* Image (and other media) upload; +* Improved editor. The editor is at present very primitive - right back from the beginnings of the Web. It would be nice to have a rich embedded editor like [Hallo](https://github.com/bergie/hallo) or [Aloha](http://aloha-editor.org/Content.Node/index.html) but I havenven't (yet) had time to integrate them! +* Improved security. Having the passwords in plain text rather than encrypted is just basically poor; having the passwd file in *public* space is also poor (although I believe it cannot be accessed via HTTP). Essentially, authentication mechanisms should be pluggable, and at present they aren't; +* Mechanism to add users through the user interface; +* Mechanism to change passwords through the user interface; ## Prerequisites @@ -42,10 +43,7 @@ Alternatively, if you want to deploy to a servlet container, the simplest thing (a command which I'm sure Smeagol would entirely appreciate) and deploy the resulting war file. -## TODO - -The editor is at present very primitive - right back from the beginnings of the Web. It would be nice to have a rich embedded editor like [Hallo](https://github.com/bergie/hallo) or [Aloha](http://aloha-editor.org/Content.Node/index.html) but I havenven't (yet) had time to integrate them! - ## License -Copyright © 2014 Simon Brooke +Copyright © 2014 Simon Brooke. Licensed under the GNU General Public License, +version 2.0 or (at your option) any later version. diff --git a/resources/public/content/Introduction.md b/resources/public/content/Introduction.md index ac3ea75..23fa4bc 100644 --- a/resources/public/content/Introduction.md +++ b/resources/public/content/Introduction.md @@ -25,6 +25,12 @@ that is to say, the username is a keyword and the corresponding password is a st * Mechanism to add users through the user interface; * Mechanism to change passwords through the user interface; +## License + +Copyright © 2014 Simon Brooke. Licensed under the GNU General Public License, +version 2.0 or (at your option) any later version. + + ## Editing the framing content You can edit the [[\_left-bar]], the [[\_edit-left-bar]], and the [[\_header]].