Cleanup

README.md

@@ -1,5 +1,7 @@
 # Shortcodes
 
+## What it is
+
 This is a parser for the shortcode spec as explained in the Hugo docs
 and used in Hugo and Nikola. Approximately.
 
@@ -12,11 +14,47 @@ as close as practical.
 * Allocates no memory, because all strings are references to
   pieces of input.
 
-What works:
+## What works
 
 * Detect shortcodes with names
 * Standalone and matched shortcodes
 * Capture data between tags in matched shortcodes
 * Capture arguments with and without names
-* Capture values with and without quotes (with details, see TODO above)
+* Capture values with and without quotes (with details, see [TODO](TODO.md))
 
+## Building
+
+You need [Ragel](http://www.colm.net/open-source/ragel/) and a C compiler.
+
+Ragel is used to generate `shortcodes.c` out of `shortcodes.rl`.
+As a convenience there is a generated `shortcodes.c` in the repo,
+
+Then:
+
+```shell
+  cd src && make
+```
+
+To run tests:
+
+```shell
+  crystal spec
+```
+
+## Installation
+
+1. Add the dependency to your `shard.yml`:
+
+   ```yaml
+   dependencies:
+     cr-discount:
+       github: ralsina/shortcodes
+   ```
+
+2. Run `shards install`
+
+## Usage
+
+```crystal
+require "shortcodes"
+```

spec/shortcodes_spec.cr

@@ -4,9 +4,9 @@ describe "Shortcodes" do
   # TODO: Write tests
 
   it "works" do
-    result = Shortcodes.parse("foo{{% bar %}}baz{{% /bar %}}qux");
+    result = Shortcodes.parse("foo{{% bar %}}baz{{% /bar %}}qux")
-    p! result.sccount;
+    result.sccount.should eq 1
-    p! result.shortcodes[0].matching;
+    result.shortcodes[0].matching.should eq 1
   end
 end
 

src/Makefile

@@ -1,4 +1,3 @@
-CC=gcc
 shortcodes.c: shortcodes.rl
 	ragel -G2 shortcodes.rl -o shortcodes.c
 clean:

src/shortcodes.cr

@@ -1,13 +1,12 @@
 @[Link(ldflags: "#{__DIR__}/shortcodes.o")]
 lib Shortcodes
-
   struct Chunk
     start : UInt32
     len : UInt32
   end
 
   struct ScError
-    position: UInt32
+    position : UInt32
     code : UInt32
   end
 
@@ -28,5 +27,5 @@ lib Shortcodes
     errcount : UInt32
   end
 
-  fun parse(input : Pointer(LibC::Char)) : ScResult;
+  fun parse(input : Pointer(LibC::Char)) : ScResult
 end