Skip to content
This repository was archived by the owner on Nov 21, 2024. It is now read-only.

Commit e06e2a5

Browse files
author
Kato Shinya
authored
Merge pull request #6 from myConsciousness/develop
update readme
2 parents 5881fe2 + 6dd3d36 commit e06e2a5

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
11
![Build](https://img.shields.io/badge/Build-Automated-2980b9.svg?style=for-the-badge)
2-
![Latest Version](https://img.shields.io/badge/Latest_Version-v1.0.2-27ae60.svg?style=for-the-badge)
2+
![Latest Version](https://img.shields.io/badge/Latest_Version-v1.0.3-27ae60.svg?style=for-the-badge)
33
![License](https://img.shields.io/badge/License-Apache_2.0-e74c3c.svg?style=for-the-badge)</br>
44
![Java CI with Gradle](https://github.com/myConsciousness/catalog-api/workflows/Java%20CI%20with%20Gradle/badge.svg)
55

6-
# Catalog API
6+
# 1. Catalog API
77

88
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
99
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1010
**Table of Contents**
1111

12-
- [What is it?](#what-is-it)
13-
- [Benefits](#benefits)
14-
- [How To Use](#how-to-use)
15-
- [1. Add the dependencies](#1-add-the-dependencies)
16-
- [2. Select interface you want to use](#2-select-interface-you-want-to-use)
17-
- [3. Import and implement Enum with Catalog / BiCatalog interface](#3-import-and-implement-enum-with-catalog--bicatalog-interface)
18-
- [License](#license)
19-
- [More Information](#more-information)
12+
- [1.1. What is it?](#11-what-is-it)
13+
- [1.2. Benefits](#12-benefits)
14+
- [1.3. How To Use](#13-how-to-use)
15+
- [1.3.1. Add the dependencies](#131-add-the-dependencies)
16+
- [1.3.2. Select interface you want to use](#132-select-interface-you-want-to-use)
17+
- [1.3.3. Import and implement Enum with Catalog / BiCatalog interface](#133-import-and-implement-enum-with-catalog--bicatalog-interface)
18+
- [1.4. License](#14-license)
19+
- [1.5. More Information](#15-more-information)
2020

2121
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2222

23-
## What is it?
23+
## 1.1. What is it?
2424

2525
**_Make easier to maintain and use constants!_**
2626

2727
This is a Java-based API designed to make the constants group more maintainable and extensible.<br>
2828
It manages regularized constants as a single `catalog` and provides a convenient utility interface to manipulate the `catalog`.
2929

30-
## Benefits
30+
## 1.2. Benefits
3131

3232
- It assumes the use of `Enum`
3333
- Necessary processes for constant operation are integrated in the interface
3434
- Useful common behaviors can be used anywhere
3535
- No need to use `public static final` constant classes anymore
3636
- **_Easy to maintain and use constants!_**
3737

38-
## How To Use
38+
## 1.3. How To Use
3939

40-
### 1. Add the dependencies
40+
### 1.3.1. Add the dependencies
4141

4242
> **_Note:_**<br>
4343
> Replace version you want to use. Check the latest [Packages](https://github.com/myConsciousness/catalog-api/packages).<br>
@@ -49,7 +49,7 @@ It manages regularized constants as a single `catalog` and provides a convenient
4949
<dependency>
5050
<groupId>org.thinkit.api.catalog</groupId>
5151
<artifactId>catalog-api</artifactId>
52-
<version>v1.0.2</version>
52+
<version>v1.0.3</version>
5353
</dependency>
5454

5555
<servers>
@@ -76,11 +76,11 @@ repositories {
7676
}
7777
7878
dependencies {
79-
implementation 'org.thinkit.api.catalog:catalog-api:v1.0.2'
79+
implementation 'org.thinkit.api.catalog:catalog-api:v1.0.3'
8080
}
8181
```
8282

83-
### 2. Select interface you want to use
83+
### 1.3.2. Select interface you want to use
8484

8585
The `Catalog API` currently provides the following interfaces.<br>
8686
Choose the interface you want to use depending on your needs.
@@ -90,7 +90,7 @@ Choose the interface you want to use depending on your needs.
9090
| **_Catalog<E extends Catalog<E>>_** | This is the basic catalog interface.<br>Elements of the concrete catalog class that implement this interface have a `code value`.<br>You can use the common behavior defined in the Catalog interface. |
9191
| **_BiCatalog<E extends BiCatalog<E, T>, T>_** | Each element of a concrete catalog class that implements this interface can have a `code value` plus a `value of any data type`.<br>The arbitrary data type is defined at the time of implementation of the concrete catalog class.<br>You can use the common behavior of the interface. |
9292

93-
### 3. Import and implement Enum with Catalog / BiCatalog interface
93+
### 1.3.3. Import and implement Enum with Catalog / BiCatalog interface
9494

9595
**_Catalog<E extends Catalog<E>>_**
9696

@@ -174,7 +174,7 @@ public enum TestBiCatalog implements BiCatalog<TestBiCatalog, String> {
174174
}
175175
```
176176

177-
## License
177+
## 1.4. License
178178

179179
```
180180
Copyright 2020 Kato Shinya.
@@ -190,7 +190,7 @@ or implied. See the License for the specific language governing permissions and
190190
the License.
191191
```
192192

193-
## More Information
193+
## 1.5. More Information
194194

195195
`Catalog API` was designed and implemented by Kato Shinya, who works as a freelance developer.
196196

0 commit comments

Comments
 (0)