Skip to content

Commit 9313526

Browse files
geirolzgeirolz
committed
Fix doc
1 parent 68d5f26 commit 9313526

File tree

2 files changed

+43
-17
lines changed

2 files changed

+43
-17
lines changed

‎README.md

+21-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Fly4s
2-
[![Build Status](https://github.com/geirolz/fly4s/actions/workflows/cicd.yml/badge.svg)](https://github.com/geirolz/fly4s/actions)
3-
[![codecov](https://img.shields.io/codecov/c/github/geirolz/fly4s)](https://codecov.io/gh/geirolz/fly4s)
4-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/db3274b55e0c4031803afb45f58d4413)](https://www.codacy.com/manual/david.geirola/fly4s?utm_source=github.com&utm_medium=referral&utm_content=geirolz/fly4s&utm_campaign=Badge_Grade)
2+
[![Build Status](https://github.com/geirolz/fly4s/actions/workflows/cicd.yml/badge.svg?query=branch%3A0.x-9.x)](https://github.com/geirolz/fly4s/actions?query=branch%3A0.x-9.x)
3+
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/32b85d22894d479491bed9bbf64a2651)](https://app.codacy.com/gh/geirolz/fly4s/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
4+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/32b85d22894d479491bed9bbf64a2651)](https://app.codacy.com/gh/geirolz/fly4s/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
55
[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/com.github.geirolz/fly4s_2.13?server=https%3A%2F%2Foss.sonatype.org)](https://mvnrepository.com/artifact/com.github.geirolz/fly4s)
66
[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
77
[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/geirolz/fly4s&style=flat)](https://mergify.io)
8-
[![GitHub license](https://img.shields.io/github/license/geirolz/fly4s)](https://github.com/geirolz/fly4s/blob/main/LICENSE)
8+
[![GitHub license](https://img.shields.io/github/license/geirolz/fly4s)](https://github.com/geirolz/fly4s/blob/0.x-9.x/LICENSE)
99

1010
<div align="center">
1111
<img src="images/logo.png" alt="logo" width="50%"/>
@@ -15,9 +15,10 @@ A lightweight, simple and functional wrapper for Flyway using cats-effect.
1515

1616
### Compatibility matrix
1717

18-
| **Fly4s** | **Flyway** |
19-
|----------------------------------------------------------------------|------------|
20-
| [0.x](https://github.com/geirolz/fly4s/releases?q=0.&expanded=false) | 9.x |
18+
| **Fly4s** | **Flyway** | **Branch** |
19+
|:---------------------------------------------------------------------:|:----------:|:--------------------------------------------------------:|
20+
| [0.x](https://github.com/geirolz/fly4s/releases?q=v0.&expanded=false) | 9.x | [0.x-9.x](https://github.com/geirolz/fly4s/tree/0.x-9.x) |
21+
| [1.x](https://github.com/geirolz/fly4s/releases?q=v1.&expanded=false) | 10.x | [main](https://github.com/geirolz/fly4s/tree/main) |
2122

2223

2324
The most famous library to handle database migrations in Java is for sure Flyway.
@@ -41,6 +42,14 @@ To achieve this goal, `Fly4s` use the typelevel libraries `cats` and `cats-effec
4142
### Adopters
4243
If you are using Fly4s in your company, please let me know and I'll add it to the list! It means a lot to me.
4344

45+
<a href="https://www.codacy.com/">
46+
<picture>
47+
<source media="(prefers-color-scheme: dark)" srcset="https://www.codacy.com/hubfs/Codacy_2023/Images/logo_codacy_white.svg">
48+
<source media="(prefers-color-scheme: light)" srcset="https://www.codacy.com/hubfs/Codacy_2023/Images/logo_codacy.svg">
49+
<img alt="Codacy Logo" height=55 >
50+
</picture>
51+
</a>
52+
4453
### Getting started
4554
Fly4s supports Scala 2.13 and 3.
4655
The first step, import the `Fly4s` library in our SBT project.
@@ -51,6 +60,10 @@ Fly4s depends on Flyway, so we'll have access to Flyway as well
5160
libraryDependencies += "com.github.geirolz" %% "fly4s" % "0.0.20"
5261
```
5362

63+
Remember to also import the specific database module from Flyway
64+
65+
https://documentation.red-gate.com/flyway/flyway-cli-and-api/supported-databases
66+
5467
### Migrations files
5568
As the plain Flyway, we have to create a folder that will contain our migrations scripts, often in `resources/db`.
5669

@@ -139,7 +152,7 @@ val fly4sRes: Resource[IO, Fly4s[IO]] = Fly4s.make[IO](
139152
)
140153
)
141154
// fly4sRes: Resource[IO, Fly4s[IO]] = Allocate(
142-
// resource = cats.effect.kernel.Resource$$$Lambda/0x0000000704122cc0@7c888df7
155+
// resource = cats.effect.kernel.Resource$$$Lambda/0x0000000705335800@3e68279d
143156
// )
144157
```
145158

‎docs/README.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Fly4s
2-
[![Build Status](https://github.com/geirolz/@PRJ_NAME@/actions/workflows/cicd.yml/badge.svg)](https://github.com/geirolz/@PRJ_NAME@/actions)
3-
[![codecov](https://img.shields.io/codecov/c/github/geirolz/@PRJ_NAME@)](https://codecov.io/gh/geirolz/@PRJ_NAME@)
4-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/db3274b55e0c4031803afb45f58d4413)](https://www.codacy.com/manual/david.geirola/@PRJ_NAME@?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=geirolz/@PRJ_NAME@&amp;utm_campaign=Badge_Grade)
5-
[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/com.github.geirolz/@MODULE_NAME@_2.13?server=https%3A%2F%2Foss.sonatype.org)](https://mvnrepository.com/artifact/com.github.geirolz/@MODULE_NAME@)
2+
[![Build Status](https://github.com/geirolz/fly4s/actions/workflows/cicd.yml/badge.svg?query=branch%3A0.x-9.x)](https://github.com/geirolz/fly4s/actions?query=branch%3A0.x-9.x)
3+
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/32b85d22894d479491bed9bbf64a2651)](https://app.codacy.com/gh/geirolz/fly4s/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
4+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/32b85d22894d479491bed9bbf64a2651)](https://app.codacy.com/gh/geirolz/fly4s/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
5+
[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/com.github.geirolz/fly4s_2.13?server=https%3A%2F%2Foss.sonatype.org)](https://mvnrepository.com/artifact/com.github.geirolz/fly4s)
66
[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
7-
[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/geirolz/@PRJ_NAME@&style=flat)](https://mergify.io)
8-
[![GitHub license](https://img.shields.io/github/license/geirolz/@PRJ_NAME@)](https://github.com/geirolz/@PRJ_NAME@/blob/main/LICENSE)
7+
[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/geirolz/fly4s&style=flat)](https://mergify.io)
8+
[![GitHub license](https://img.shields.io/github/license/geirolz/fly4s)](https://github.com/geirolz/fly4s/blob/0.x-9.x/LICENSE)
99

1010
<div align="center">
1111
<img src="images/logo.png" alt="logo" width="50%"/>
@@ -15,9 +15,10 @@ A lightweight, simple and functional wrapper for Flyway using cats-effect.
1515

1616
### Compatibility matrix
1717

18-
| **Fly4s** | **Flyway** |
19-
|----------------------------------------------------------------------|------------|
20-
| [0.x](https://github.com/geirolz/fly4s/releases?q=0.&expanded=false) | 9.x |
18+
| **Fly4s** | **Flyway** | **Branch** |
19+
|:---------------------------------------------------------------------:|:----------:|:--------------------------------------------------------:|
20+
| [0.x](https://github.com/geirolz/fly4s/releases?q=v0.&expanded=false) | 9.x | [0.x-9.x](https://github.com/geirolz/fly4s/tree/0.x-9.x) |
21+
| [1.x](https://github.com/geirolz/fly4s/releases?q=v1.&expanded=false) | 10.x | [main](https://github.com/geirolz/fly4s/tree/main) |
2122

2223

2324
The most famous library to handle database migrations in Java is for sure Flyway.
@@ -41,6 +42,14 @@ To achieve this goal, `Fly4s` use the typelevel libraries `cats` and `cats-effec
4142
### Adopters
4243
If you are using Fly4s in your company, please let me know and I'll add it to the list! It means a lot to me.
4344

45+
<a href="https://www.codacy.com/">
46+
<picture>
47+
<source media="(prefers-color-scheme: dark)" srcset="https://www.codacy.com/hubfs/Codacy_2023/Images/logo_codacy_white.svg">
48+
<source media="(prefers-color-scheme: light)" srcset="https://www.codacy.com/hubfs/Codacy_2023/Images/logo_codacy.svg">
49+
<img alt="Codacy Logo" height=55 >
50+
</picture>
51+
</a>
52+
4453
### Getting started
4554
Fly4s supports Scala 2.13 and 3.
4655
The first step, import the `Fly4s` library in our SBT project.
@@ -51,6 +60,10 @@ Fly4s depends on Flyway, so we'll have access to Flyway as well
5160
libraryDependencies += "@ORG@" %% "@MODULE_NAME@" % "@VERSION@"
5261
```
5362

63+
Remember to also import the specific database module from Flyway
64+
65+
https://documentation.red-gate.com/flyway/flyway-cli-and-api/supported-databases
66+
5467
### Migrations files
5568
As the plain Flyway, we have to create a folder that will contain our migrations scripts, often in `resources/db`.
5669

0 commit comments

Comments
 (0)