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

Commit d10be0b

Browse files
authored
update README
1 parent 3cc2d22 commit d10be0b

File tree

1 file changed

+34
-37
lines changed

1 file changed

+34
-37
lines changed

README.md

Lines changed: 34 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
<img src="https://raw.githubusercontent.com/KatsuteDev/simplehttpserver/main/assets/icon.png" alt="icon" width="100" height="100">
44
</a>
55
<h3>SimpleHttpServer</h3>
6-
<h5>A simple and efficient HTTP server for Java</h5>
6+
<strong>A simple and efficient HTTP server for Java</strong>
77
<div>
88
<a href="https://docs.katsute.dev/simplehttpserver">Documentation</a>
9-
<br>
9+
<br>
1010
<a href="https://mvnrepository.com/artifact/dev.katsute/simplehttpserver">Maven Central</a>
1111
1212
<a href="https://github.com/KatsuteDev/simplehttpserver/packages/1569580">GitHub Packages</a>
@@ -21,33 +21,30 @@
2121
2222
Simplified httpserver experience for Java 8. Includes extensible servers and handlers for complex operations.
2323

24-
- [📃 Installation](#-installation)
25-
- [✨ Features](#-features)
26-
- [👨‍💻 Contributing](#-contributing)
27-
- [💼 License](#-license)
24+
## Installation
2825

29-
## 📃 Installation
30-
31-
simplehttpserver5 requires at least Java 8. No additional dependencies/libraries are required.
26+
This library requires at least Java 8. No additional dependencies are required.
3227

3328
Compiled binaries can be installed from:
3429

35-
- [Maven Central](https://mvnrepository.com/artifact/dev.katsute/simplehttpserver)
36-
- [GitHub Packages](https://github.com/KatsuteDev/simplehttpserver/packages/1569580)
37-
- [Releases](https://github.com/KatsuteDev/simplehttpserver/releases)
30+
* [Maven Central](https://mvnrepository.com/artifact/dev.katsute/simplehttpserver)
31+
* [GitHub Packages](https://github.com/KatsuteDev/simplehttpserver/packages/1569580)
32+
* [Releases](https://github.com/KatsuteDev/simplehttpserver/releases)
3833

3934
Refer to the [documentation](https://docs.katsute.dev/simplehttpserver) to learn how to use servers and handlers.
4035

41-
## ✨ Features
36+
<div align="right"><a href="#top"><code>▲</code></a></div>
37+
38+
## Features
4239

43-
### ✔️ Complicated tasks made easy
40+
### Complicated tasks made easy
4441

4542
Simplified exchange methods for:
4643

47-
- Parsing `GET`/`POST` requests, including `multipart/form-data` support.
48-
- Accessing cookies.
49-
- Sending byte arrays, strings, and files to clients.
50-
- Sending gzip compressed responses.
44+
* Parsing `GET`/`POST` requests, including `multipart/form-data` support.
45+
* Accessing cookies.
46+
* Sending byte arrays, strings, and files to clients.
47+
* Sending gzip compressed responses.
5148

5249
```java
5350
SimpleHttpHandler handler = new SimpleHttpHandler(){
@@ -62,13 +59,13 @@ SimpleHttpHandler handler = new SimpleHttpHandler(){
6259
};
6360
```
6461

65-
### More Features
62+
### More Features
6663

6764
Features not included with a regular HTTP server:
6865

69-
- Cookies
70-
- Sessions
71-
- Multithreaded Servers
66+
* Cookies
67+
* Sessions
68+
* Multithreaded Servers
7269

7370
```java
7471
SimpleHttpServer server = new SimpleHttpServer(8080);
@@ -84,18 +81,18 @@ SimpleHttpHandler handler = new SimpleHttpHandler(){
8481
};
8582
```
8683

87-
### 🌐 Simplified Handlers
84+
### Simplified Handlers
8885

8986
Simple and extensible request handlers:
9087

91-
- Redirect Handler
92-
- Predicate Handler
93-
- Root `/` Handler
94-
- File Handler
95-
- Server-Sent-Events (SSE) Handler
96-
- Temporary Handler
97-
- Timeout Handler
98-
- Throttled Handler
88+
* Redirect Handler
89+
* Predicate Handler
90+
* Root `/` Handler
91+
* File Handler
92+
* Server-Sent-Events (SSE) Handler
93+
* Temporary Handler
94+
* Timeout Handler
95+
* Throttled Handler
9996

10097
```java
10198
RedirectHandler redirect = new RedirectHandler("https://github.com/");
@@ -107,7 +104,9 @@ SSE.push("Server sent events!");
107104
ThrottledHandler throttled = new ThrottledHandler(new ServerExchangeThrottler(), new HttpHandler());
108105
```
109106

110-
## 👨‍💻 Contributing
107+
<div align="right"><a href="#top"><code>▲</code></a></div>
108+
109+
## Contributing
111110

112111
<!-- Copilot -->
113112
<table>
@@ -119,18 +118,16 @@ ThrottledHandler throttled = new ThrottledHandler(new ServerExchangeThrottler(),
119118
</table>
120119
<!-- Copilot -->
121120

122-
#### 💻 Running Tests Locally
121+
#### Running Tests Locally
123122

124123
For local tests you can use Java 8+, however only methods in the Java 8 API may be used. The `src/main/java9` folder should not be marked as a source root.
125124

126-
#### 🌐 Running Tests using GitHub Actions
125+
#### Running Tests using GitHub Actions
127126

128127
Each commit automatically triggers the Java CI workflow, make sure you have actions enabled on your forks.
129128

130129
<div align="right"><a href="#top"><code>▲</code></a></div>
131130

132-
<hr>
133-
134-
### 💼 License
131+
## &nbsp;
135132

136133
This library is released under the [GNU General Public License (GPL) v2.0](https://github.com/KatsuteDev/simplehttpserver/blob/main/LICENSE).

0 commit comments

Comments
 (0)