chore: add simple readme
This commit is contained in:
parent
edb234d44f
commit
e8ac947f3e
2 changed files with 35 additions and 0 deletions
34
README.md
Normal file
34
README.md
Normal file
|
@ -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`
|
|
@ -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]]
|
||||
|
|
Reference in a new issue