Adding "Usage" section to the README.md.
This commit is contained in:
parent
dcd778f472
commit
cc9ad9a1e6
22
README.md
22
README.md
|
@ -6,10 +6,26 @@ This simple utility will help you to migrate your data from legacy
|
|||
Python version of `magneticod` to the new Go version which uses new
|
||||
persistence layer.
|
||||
|
||||
## Install
|
||||
## Installation
|
||||
|
||||
TBW
|
||||
|
||||
## Run
|
||||
## Usage
|
||||
|
||||
TBW
|
||||
### Important notes:
|
||||
|
||||
- For `--py-database` syntax is similar but not the same. But if you'll use just
|
||||
`sqlite3://` schema and path to the database you'll be ok.
|
||||
- For `--go-database` you can use the same syntax as used in `magneticod` CLI interface.
|
||||
|
||||
### Merging with magneticod-go's PostgreSQL
|
||||
|
||||
```shell
|
||||
./magnetico-go-migrator --py-database=sqlite3:///path/to/old/database.sqlite3 --go-database=postgres://username:password@hostname/db_name?port=5432&sslmode=disable
|
||||
```
|
||||
|
||||
### Merging into magneticod-go's Beanstalk
|
||||
|
||||
```shell
|
||||
./magnetico-go-migrator --py-database=sqlite3:///path/to/old/database.sqlite3 --go-database=beanstalk://127.0.0.1:11300/magneticod_tube
|
||||
```
|
||||
|
|
Reference in a new issue