Skip to content

Commit e6ec585

Browse files
committed
chore: update README
1 parent 01d4072 commit e6ec585

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ sql-schema
66
[![Crates.io Version](https://img.shields.io/crates/v/sql-schema)](https://crates.io/crates/sql-schema)
77
[![docs.rs](https://img.shields.io/docsrs/sql-schema)](https://docs.rs/sql-schema)
88

9-
This crate provides tools for generating schema migrations based on edits to a canonical schema file.
9+
This crate provides a command line tool for generating schema migrations based on edits to a canonical schema file.
1010

1111
## Status
1212

13-
This crate is in a very early stage of development and is missing many features.
13+
This crate is in an early stage of development and may not work with your schema or have unexpected behaviour—always double check the output.
1414

1515
## Usage
1616

@@ -33,6 +33,13 @@ sql-schema migration --name my_new_migration \
3333
# -> writing schema/migrations/1739486729_my_new_migration.down.sql
3434
```
3535

36+
## Goals
37+
38+
- Time saver: You can generate an up _and_ down migration for the cost of editing a schema.
39+
- Non restrictive: You can edit the generated migrations as needed (e.g. if you need to migrate data along side a schema change).
40+
- Minimal buy-in: You don't have to change anything about your project to start or stop using it (committing the generated schema is optional).
41+
- Works with any SQL dialect.
42+
3643
## Licensing
3744

3845
All code in this repository is licensed under the [Apache Software License 2.0](LICENSE.txt).

0 commit comments

Comments
 (0)