From e8ac947f3e87908401b1164a725374490128aedb Mon Sep 17 00:00:00 2001
From: Dmitriy Pleshevskiy <dmitriy@ideascup.me>
Date: Mon, 8 Feb 2021 07:41:52 +0300
Subject: [PATCH] chore: add simple readme

---
 README.md            | 34 ++++++++++++++++++++++++++++++++++
 migra-cli/Cargo.toml |  1 +
 2 files changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb5884b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Migra
+
+Simple SQL migration manager for your project.
+
+
+### Install
+
+```bash
+cargo install migra
+```
+
+
+### Usage
+
+A few steps to get you started
+
+1. Initialize migra configuration (Optional)
+    ```bash
+    migra init
+    ```
+2. Make your first migration
+    ```bash
+    migra make initial_migration
+    ```
+3. Check applied and pending migrations
+    ```bash
+    migra ls
+    ```
+4. Upgrade your database
+    ```bash
+    migra up
+    ```
+
+For more information about the commands, simply run `migra help`
diff --git a/migra-cli/Cargo.toml b/migra-cli/Cargo.toml
index 5aac181..07248ab 100644
--- a/migra-cli/Cargo.toml
+++ b/migra-cli/Cargo.toml
@@ -9,6 +9,7 @@ repository = "https://github.com/pleshevskiy/migra"
 license = "MIT OR Apache-2.0"
 keywords = ["migration", "cli", "sql", "manager"]
 categories = ["accessibility", "database", "command-line-interface"]
+readme = "../README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [[bin]]