Update docs and screenshot, prepare for v0.3.0

README.md

@@ -2,8 +2,8 @@
 
 Elegant wiki powered by Crystal, with markdown as native format and a WYSIWYG editor.
 
-It currently uses file-based storage, versioned using Git. Wiki pages are created as files and directories on disk and they can be modified in Fluence or via filesystem directly.
-Please submit your opinion on this in the issue [Storage backend - files or database?](https://github.com/crystallabs/fluence/issues/1).
+It uses file-based storage versioned using Git. Wiki pages are created as files and directories on disk and they can be modified in Fluence or via filesystem directly.
+(Please submit any opinions on this approach in [Storage backend - files or database?](https://github.com/crystallabs/fluence/issues/1).)
 
 Fluence uses Bootstrap 4 and jQuery 3.3.1 slim.
 
@@ -22,6 +22,8 @@ The result of the compilation will be one executable file — bin/fluence.
 
 Run it, and visit [http://localhost:3000/](http://localhost:3000/) in your browser.
 
+To configure Fluence, please do so in `config/options.cr`.
+
 ## Example
 
 Here's how it currently looks:

config/options.cr

@@ -2,28 +2,40 @@ module Fluence
   class Options
     def initialize
 
+			# Brand name, full name (including optional credit to Fluence Wiki), and logo.
 			@brand = "Fluence"
 			@brand_info = "#{@brand} - Fluence Wiki"
 			@brand_logo = "/logo.png"
 
+			# Location of data/ and meta/ directories. Defaults to $PWD/{data,meta}
       @datadir = ::File.expand_path ENV.fetch("FLUENCE_DATADIR", "data"), Dir.current
       @metadir = ::File.expand_path ENV.fetch("FLUENCE_METADIR", "meta"), Dir.current
 
+			# Visible part of URL through which pages are accessed, e.g. /pages/my_page
 			@pages_prefix = "/pages"
+			# Start page / homepage. Defaults to /pages/home
 			@homepage = ::File.join @pages_prefix, "home"
 
+			# Visible part of URL through which media is accessed, e.g. /media/my_page/my_file1.pdf
 			@media_prefix = "/media"
 
+			# Location of users and admin interfaces
 			@users_prefix = "/users"
-
 			@admin_prefix = "/admin"
 
+			# Recursion limit for any recursive functions
 			@recursion_limit = 1000
 
+			# Do all, or only new and/or only empty pages open in edit mode by default?
+			# By default, only new pages open in edit mode; existing and empty pages open in view mode.
 			@open_in_edit = false
 			@open_new_in_edit = true
 			@open_empty_in_edit = false
 
+			#
+			# No need to configure anything below this point.
+			#
+
       Dir.mkdir_p @datadir
       Dir.mkdir_p @metadir
     end

shard.yml

@@ -1,5 +1,5 @@
 name: fluence
-version: 0.2.0
+version: 0.3.0
 
 authors:
   - Davor Ocelic <[email protected]>

src/fluence/version.cr

@@ -1,6 +1,6 @@
 module Fluence
   VERSION_MAJOR = 0
-  VERSION_MINOR = 2
+  VERSION_MINOR = 3
   VERSION_REVISION = 0
   VERSION = [ VERSION_MAJOR, VERSION_MINOR, VERSION_REVISION ].join '.'
 end