Skip to content

Commit bfc6deb

Browse files
committed
chore: update README with usage examples, FAQ section, and language requirements
1 parent f509899 commit bfc6deb

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,59 @@
11
<!--
2-
SPDX-FileCopyrightText: Copyright © 2024, 2025 Caleb Cushing
2+
SPDX-FileCopyrightText: Copyright © 2024 2025 Caleb Cushing
3+
SPDX-FileCopyrightText: Copyright © 2025 Caleb Cushing
34
45
SPDX-License-Identifier: CC-BY-NC-4.0
56
-->
67

78
# README
89

10+
## Usage
11+
12+
```kt
13+
// settings.gradle.kts
14+
dependencyResolutionManagement {
15+
versionCatalogs {
16+
create("sb") {
17+
from("com.xenoterracide.gradle.vc:version-catalog-spring-boot:3.5.0")
18+
}
19+
}
20+
}
21+
```
22+
23+
```kt
24+
// build.gradle.kts
25+
dependencies {
26+
implementation(sb.spring.boot.starter.data.jpa.test)
27+
}
28+
```
29+
30+
## FAQ
31+
32+
### Versions
33+
34+
In order to make life easier the first 2 numbers of the version catalog will match the Spring Boot version. The 3rd number will be incremented for any patches or minor changes needed.
35+
36+
### Gradle Support
37+
38+
Gradle Versions older than 7.2 will not work. Gradle 7.4 was the first stable release for version catalogs.
39+
40+
## Development
41+
942
### Languages
1043

1144
[asdf](https://asdf-vm.com) is suggested, you can use whatever you'd like to get
1245

13-
- Java 11+
46+
- Java 17+
1447
- NodeJs
48+
- Python 3.11+
1549

1650
add a way to export these to your `PATH` in your `~/.profile`
1751

1852
### Build Tools
1953

2054
- [Gradle](https://docs.gradle.org/current/userguide/command_line_interface.html)
21-
- [Yarn 4](https://yarnpkg.com/getting-started/install) (via Corepack)
55+
- [Yarn 4 - formatting commit hooks](https://yarnpkg.com/getting-started/install) (via Corepack)
56+
- [PIP - reuse license header commit hooks](https://pip.pypa.io/en/stable/)
2257

2358
#### Fetching Dependencies
2459

0 commit comments

Comments
 (0)