From c899fd8de64083175ac6c6a35cd79b838fd5a7db Mon Sep 17 00:00:00 2001
From: mappu <mappu04@gmail.com>
Date: Sat, 6 Oct 2018 15:47:03 +1300
Subject: [PATCH] doc: readme

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f4d7b02
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# hg2git
+
+A wrapper script to convert a mercurial repository to git using `mercurial-git`.
+
+## Usage
+
+```
+hg2git ./my-mercurial-repo/
+```
+
+## Features
+
+- Handle necessary bare-repo intermediate state
+- Handle necessary master hg bookmark
+- Preserve ignored files in working directory
+- Clean up hgtags files
+- Partial conversion of hgignore to gitignore
+
+## Changelog
+
+2018-10-06 v1.0.0
+- Initial public release