Skip to content

Commit 0273a70

Browse files
committed
Move templates to github folder and update readme
1 parent 8f796ac commit 0273a70

File tree

4 files changed

+35
-13
lines changed

4 files changed

+35
-13
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,36 @@
55

66
A java helper utilities that form HTTP security header for authentication and verification
77

8+
## Table of Contents
9+
- [Getting Started](#getting-started)
10+
* [Using Maven](#maven-guide)
11+
+ [Maven Build Option](#maven-build-option)
12+
* [Using Gradle](#gradle-guide)
13+
+ [Preparation](#preparation)
14+
+ [Gradle Build Option](#gradle-build-option)
15+
+ [Gradle Test](#gradle-test)
16+
* [Development](#development)
17+
+ [Constructing Signature BaseString](#constructing-signature-basestring)
18+
+ [Constructing HMAC256 L1 Header](#constructing-hmac256-l1-header)
19+
+ [Constructing RSA256 L2 Header](#constructing-rsa256-l2-header)
20+
+ [Preparing HTTP Signature Token](#preparing-http-signature-token)
21+
- [Release](#release)
22+
- [Contributing](#contributing)
23+
- [License](#license)
24+
- [References](#references)
25+
826
## Getting Started
927
Include this helper class in your java project to perform API Security operations
1028

1129
This project use Maven or Gradle as its build and management tools
1230

31+
1332
### Maven Guide
1433

1534
+ Download and Install Maven (3.5.0 or above)
1635
+ Java (1.8)
1736

18-
#### Build
37+
#### Maven Build Option
1938

2039
**Option 1:** Compile and package into JAR
2140

@@ -76,14 +95,14 @@ As some of the test cases contains UTF-8 characters, you have to set following p
7695
export GRADLE_OPTS="-Dfile.encoding=utf-8"
7796
```
7897

79-
#### Build
98+
#### Gradle Build Option
8099
**Option 1:** Compile and package into JAR
81100

82101
```bash
83102
gradle clean build
84103
```
85104

86-
#### Test
105+
#### Gradle Test
87106
To test with Jacoco and publish a html report
88107

89108
```bash
@@ -111,9 +130,9 @@ dependencies {
111130
112131
```
113132

114-
#### Development
133+
### Development
115134

116-
##### Preparing Signature BaseString :
135+
#### Constructing Signature BaseString
117136

118137
Method:
119138
* getBaseString
@@ -156,7 +175,7 @@ System.out.println(baseString);
156175

157176
```
158177

159-
##### Preparing HMACSHA256 L1 Security Signature :
178+
#### Constructing HMAC256 L1 Header
160179

161180
Method:
162181
* getHMACSignature
@@ -180,7 +199,7 @@ try {
180199

181200
```
182201

183-
##### Preparing RSA256 L2 Security Signature :
202+
#### Constructing RSA256 L2 Header
184203

185204
Method:
186205
* getRSASignature
@@ -213,7 +232,7 @@ try {
213232

214233
```
215234

216-
##### Preparing HTTP Signature Token :
235+
#### Preparing HTTP Signature Token
217236

218237
Append this signature token into the Authorization header of the HTTP request
219238

@@ -250,13 +269,16 @@ try {
250269
}
251270
```
252271

253-
### Contributing
254-
+ For more information about contributing PRs and issues, see [CONTRIBUTING.md](CONTRIBUTING.md).
272+
## Contributing
273+
For more information about contributing PRs and issues, see [CONTRIBUTING.md](.github/CONTRIBUTING.md).
274+
275+
## Release
276+
See [CHANGELOG.md](CHANGELOG.md).
255277

256-
### Release
257-
+ See [CHANGELOG.md](CHANGELOG.md).
278+
## License
279+
[MIT LICENSE](LICENSE).
258280

259-
### Reference:
281+
## References
260282
+ [UTF-8 in Gradle](https://stackoverflow.com/questions/21267234/show-utf-8-text-properly-in-gradle)
261283
+ [SLF4J FAQ](https://www.slf4j.org/faq.html)
262284
+ [Akana API Consumer Security](http://docs.akana.com/ag/cm_policies/using_api_consumer_app_sec_policy.htm)

0 commit comments

Comments
 (0)