Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
noritakaIzumi committed Oct 27, 2024
1 parent 702da3f commit acb603e
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,20 @@

![logo](https://raw.githubusercontent.com/noritakaIzumi/chronovoyage/main/assets/images/logo.jpeg)

Chronovoyage is a simple database migration framework.

[Visit Documentation](https://chronovoyagemigration.net/)

-----

## Table of Contents

- [Installation](#Installation)
- [License](#License)
- [Contributing](#Contributing)
- [Simple Usage](#simple-usage)
- [Contributing](#contributing)
- [Security Policy](#security-policy)
- [License](#license)

## Installation
## Simple Usage

To use MariaDB version, you need the MariaDB development package (`libmariadb-dev` in apt).

Expand Down Expand Up @@ -66,23 +71,25 @@ Then, migrate.
chronovoyage migrate
```

## For more information

We have a documentation for more details.

https://chronovoyagemigration.net/

## Contributing

Please read the following docs before you contribute to this repo:

- [Contributing](CONTRIBUTING.md)
- [Code Of Conduct](CODE_OF_CONDUCT.md)

## Security Policy

We support the latest version based on GitHub's vulnerability alerts.

[Security Policy](SECURITY.md)

## License

`chronovoyage` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

[License](LICENSE.txt)

## Roadmap

- Support for Python
Expand Down

0 comments on commit acb603e

Please sign in to comment.