2 files changed, 33 insertions(+), 2 deletions(-)

M Cargo.toml
A READMD.md

@@ 1,10 1,10 @@
 [package]
 name = "flatiron"
-version = "1.0.2"
+version = "1.0.3"
 edition = "2021"
 description = "A parser and HTML renderer for the Textile markup language"
 license-file = "LICENSE.textile"
-readme = "README.textile"
+readme = "READMD.md"
 homepage = "https://github.com/autumnull/flatiron/"
 repository = "https://github.com/autumnull/flatiron/"
 keywords = ["textile", "parser", "html", "markup", "converter"]

@@ 0,0 1,31 @@
+![A picture of an old flatiron with the word "Flatiron" written below](https://github.com/autumnull/flatiron/raw/main/images/flatiron.png)
+
+# Flatiron
+
+A parser and HTML renderer for the [Textile markup language](https://web.archive.org/web/20021226034931/http://textism.com/article/648/) , written in rust.
+
+> "she's an outlaw loose and runnin' came the whisper from each lip,
+and she's here to do -REDACTED- with the flatiron on her hip..." 🎵
+
+## Principles
+
+*"It should do what it says on the iron!"*<br />
+-- Autumn, just now, writing this.
+
+**Flatiron** aims to be:
+
+- *Simple* -- It's just a flat piece of iron with a handle on it! You heat it up! It works!
+- *Sturdy* -- Made of iron alloyed with pure XHTML!
+- *Opinionated* -- A flatiron that knows how to center images! How? don't ask me!
+- *Better than that other guy's* -- No wait you don't get it, the rust makes it *safer* to use!
+
+## Usage
+
+The flatiron can be warmed on a stove pipe:
+```sh
+$ cat sample.textile | flatiron
+```
+
+## Contributing
+
+Find any [lice](https://en.wikipedia.org/wiki/Clothes_iron#Hygiene)? I always appreciate [offers to fix up my flatiron](https://github.com/autumnull/flatiron/pulls)!