From 5e18b48b7db13b12347e0dcb01dd4a42096c6989 Mon Sep 17 00:00:00 2001
From: Victor Gil <baskeboler@gmail.com>
Date: Sun, 13 Dec 2020 18:59:39 -0300
Subject: [PATCH] update readme, changelog and docs

---
 CHANGELOG.md | 42 ++++++++++++++++++++----------------------
 README.md    |  2 +-
 doc/intro.md | 18 ++++++++++++++++++
 3 files changed, 39 insertions(+), 23 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8689114..9975943 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,24 +1,22 @@
-# Change Log
-All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
 
-## [Unreleased]
-### Changed
-- Add a new arity to `make-widget-async` to provide a different widget shape.
+n.n.n / 2020-12-13
+==================
 
-## [0.1.1] - 2019-01-15
-### Changed
-- Documentation on how to make the widgets.
-
-### Removed
-- `make-widget-sync` - we're all async, all the time.
-
-### Fixed
-- Fixed widget maker to keep working when daylight savings switches over.
-
-## 0.1.0 - 2019-01-15
-### Added
-- Files from the new template.
-- Widget maker public API - `make-widget-sync`.
-
-[Unreleased]: https://github.com/your-name/clj-karaoke/compare/0.1.1...HEAD
-[0.1.1]: https://github.com/your-name/clj-karaoke/compare/0.1.0...0.1.1
+  * updated project.clj for clojars deployment
+  * more refactors
+  * refactors
+  * changes frame key names
+  * readme
+  * new frame format
+  * improved frame splitting
+  * edit README
+  * remove unused stuff
+  * Merge pull request #2 from baskeboler/dev
+  * removed commented code
+  * Merge pull request #1 from baskeboler/dev
+  * added --help to cli
+  * cleaned up unused dependencies, added arg opt parsing
+  * edited README
+  * changed project namem to clj-karaoke-lyrics
+  * added main function for cli usage `program input-file output-file`
+  * initial commit
diff --git a/README.md b/README.md
index 83f10c6..8bce786 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ clojure functions and cli program that extract lyrics and timing data for sing-a
 
 ## License
 
-Copyright © 2019 
+Copyright © 2020 
 
 Distributed under the Eclipse Public License either version 1.0 or (at
 your option) any later version.
diff --git a/doc/intro.md b/doc/intro.md
index de3c00d..31234a4 100644
--- a/doc/intro.md
+++ b/doc/intro.md
@@ -1,3 +1,21 @@
 # Introduction to clj-karaoke
 
+## Building
+
+    $ lein uberjar 
+
+## Usage
+
+
+    $ java -jar clj-karaoke-0.1.0-standalone.jar input-file.mid output.json --type json
+
+## Options
+
+- `--type` either edn or json 
+- `--help` show help
+- `-i` input directory with midi files 
+- `-o` output directory where to store lyrics files 
+
+
 TODO: write [great documentation](http://jacobian.org/writing/what-to-write/)
+