Skip to content

Commit 72703c3

Browse files
committed
docs update
1 parent 9440ee6 commit 72703c3

File tree

1 file changed

+60
-12
lines changed

1 file changed

+60
-12
lines changed

README.md

Lines changed: 60 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,74 @@
11
# fw-commons
22

3-
Fw-Commons [a commons Java lib]() with spring boot framework, Supports using keycloak, filter, trace log, cached, minio server, exception handler, validate and call API with webclient
3+
Fw-Commons [a commons Java lib]() with spring boot framework, Supports using keycloak, filter, trace log, cached, minio
4+
server, exception handler, validate and call API with webclient
45

5-
[![Blog](https://img.shields.io/badge/[email protected]?logo=Pelican)](http://www.ponfee.cn)
6-
[![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
7-
[![JDK](https://img.shields.io/badge/jdk-21+-green.svg)](https://www.oracle.com/java/technologies/downloads/#java21)
6+
This README provides quickstart instructions on running [`fw-commons`]() on bare metal project spring boot.
7+
8+
[![License](https://img.shields.io/badge/license-MIT-green)](https://www.opensource.org/licenses/mit-license.php)
9+
[![JDK](https://img.shields.io/badge/jdk-21-green.svg)](https://www.oracle.com/java/technologies/downloads/#java21)
810
[![Build status](https://github.com/ponfee/commons-core/workflows/build-with-maven/badge.svg)](https://github.com/hoangtien2k3/fw-commons/actions)
9-
[![Maven Central](https://img.shields.io/badge/maven--central-1.4-orange.svg?style=plastic&logo=apachemaven)](https://central.sonatype.com/artifact/io.hoangtien2k3/fw-commons/1.1.0)
11+
[![Maven Central](https://img.shields.io/badge/maven--central-1.1.0-orange.svg?style=plastic&logo=apachemaven)](https://central.sonatype.com/artifact/io.github.hoangtien2k3/fw-commons/1.1.0)
12+
[![Gradle](https://img.shields.io/badge/gradle-1.1.0-orange.svg?style=plastic&logo=apachemaven)](https://central.sonatype.com/artifact/io.github.hoangtien2k3/fw-commons/1.1.0)
13+
14+
### ⬇️ [Download From Gradle and Maven Central](https://central.sonatype.com/artifact/cn.ponfee/commons-core/1.4)
1015

11-
### ⬇️ [Download From Maven Central](https://central.sonatype.com/artifact/cn.ponfee/commons-core/1.4)
16+
#### Maven
1217

1318
```xml
1419
<dependency>
15-
<groupId>io.github.hoangtien2k3</groupId>
16-
<artifactId>fw-commons</artifactId>
17-
<version>1.1.0</version>
20+
<groupId>io.github.hoangtien2k3</groupId>
21+
<artifactId>fw-commons</artifactId>
22+
<version>1.1.0</version>
1823
</dependency>
1924
```
2025

21-
# Using with spring-boot
26+
#### Gradle
27+
28+
```kotlin
29+
implementation("io.github.hoangtien2k3:fw-commons:1.1.0")
30+
```
31+
32+
## Installation and Getting Started
33+
34+
1. Correct and complete setup to start the program `application.yml` or `application.properties`
35+
with [CONFIG](src/main/resources/application.yml)
36+
37+
2. The [reference documentation]() includes detailed [installation instructions]() as well as a
38+
comprehensive [getting started]() guide.
39+
40+
Here is a quick teaser of a complete Spring Boot application in Java:
2241

23-
## Keycloak:
42+
```java
43+
@SpringBootApplication
44+
@ComponentScan(basePackages = {"io.hoangtien2k3.commons.*"})
45+
@ImportResource({"classpath*:applicationContext.xml"})
46+
public class Example {
47+
48+
@RequestMapping("/")
49+
String home() {
50+
return "Hello World!";
51+
}
52+
53+
public static void main(String[] args) {
54+
SpringApplication.run(Example.class, args);
55+
}
56+
}
57+
```
2458

2559
## License
26-
This code is under the [MIT License](LICENSE)
60+
61+
This project is licensed under the [`MIT License`](LICENSE).
62+
63+
```text
64+
MIT License
65+
Copyright (c) 2024 Hoàng Anh Tiến
66+
```
67+
68+
## Contributors ✨
69+
70+
<table>
71+
<tr>
72+
<td align="center"><a href="https://www.linkedin.com/in/hoangtien2k3/"><img src="https://avatars.githubusercontent.com/u/122768076?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hoàng Anh Tiến</b></sub></a><br /><a href="https://github.com/hoangtien2k3/news-app/commits?author=hoangtien2k3" title="Code">💻</a> <a href="#maintenance-hoangtien2k3" title="Maintenance">🚧</a> <a href="#ideas-hoangtien2k3" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-hoangtien2k3" title="Design">🎨</a> <a href="https://github.com/hoangtien2k3/news-app/issues?q=author%hoangtien2k3" title="Bug reports">🐛</a></td>
73+
</tr>
74+
</table>

0 commit comments

Comments
 (0)