README.md in nox-0.1.0 vs README.md in nox-0.1.1
- old
+ new
@@ -2,11 +2,11 @@
[![Gem Version](http://img.shields.io/gem/v/nox.svg)][gem]
[gem]: https://rubygems.org/gems/nox
-Nox is a command line tool (based on Thor) for doing things:
+Nox is a command line tool (based on Thør) for doing things:
* Run a micro-webserver to display GitHub markup in pages
## Installation
@@ -17,9 +17,21 @@
## Usage
### Command Line Tool
Type: `nox help` to get started
+
+### Encoding
+
+Internally all pages are transcoded to UTF-8 and served with content type
+`text/html;charset=UTF-8`. The input files are assumed to be in the encoding specified by
+your machine environment LANG variable, for example:
+
+```bash
+LANG=en_US.UTF-8
+```
+
+Set this prior to executing the server if your input files are in a different encoding.
## Development
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).