Skip to content

Commit 7f06465

Browse files
Refactor headings
1 parent 8bdadc9 commit 7f06465

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ Chisel is a fast TCP/UDP tunnel, transported over HTTP, secured via SSH. Single
1010

1111
- [Features](#features)
1212
- [Install](#install)
13+
- [Demo](#demo)
1314
- [Usage](#usage)
1415
- [Contributing](#contributing)
16+
- [Changelog](#changelog)
1517
- [License](#license)
1618

17-
### Features
19+
## Features
1820

1921
- Easy to use
2022
- [Performant](./test/bench/perf.md)\*
@@ -29,37 +31,37 @@ Chisel is a fast TCP/UDP tunnel, transported over HTTP, secured via SSH. Single
2931
- Clients optionally allow [SOCKS5](https://en.wikipedia.org/wiki/SOCKS) connections from a reversed port forward
3032
- Client connections over stdio which supports `ssh -o ProxyCommand` providing SSH over HTTP
3133

32-
### Install
34+
## Install
3335

34-
**Binaries**
36+
### Binaries
3537

3638
[![Releases](https://img.shields.io/github/release/jpillora/chisel.svg)](https://github.com/jpillora/chisel/releases) [![Releases](https://img.shields.io/github/downloads/jpillora/chisel/total.svg)](https://github.com/jpillora/chisel/releases)
3739

3840
See [the latest release](https://github.com/jpillora/chisel/releases/latest) or download and install it now with `curl https://i.jpillora.com/chisel! | bash`
3941

40-
**Docker**
42+
### Docker
4143

4244
[![Docker Pulls](https://img.shields.io/docker/pulls/jpillora/chisel.svg)](https://hub.docker.com/r/jpillora/chisel/) [![Image Size](https://images.microbadger.com/badges/image/jpillora/chisel.svg)](https://microbadger.com/images/jpillora/chisel)
4345

4446
```sh
4547
docker run --rm -it jpillora/chisel --help
4648
```
4749

48-
**Fedora**
50+
### Fedora
4951

5052
The package is maintained by the Fedora community. If you encounter issues related to the usage of the RPM, please use this [issue tracker](https://bugzilla.redhat.com/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&classification=Fedora&component=chisel&list_id=11614537&product=Fedora&product=Fedora%20EPEL).
5153

5254
```sh
5355
sudo dnf -y install chisel
5456
```
5557

56-
**Source**
58+
### Source
5759

5860
```sh
5961
$ go get -v github.com/jpillora/chisel
6062
```
6163

62-
### Demo
64+
## Demo
6365

6466
A [demo app](https://chisel-demo.herokuapp.com) on Heroku is running this `chisel server`:
6567

@@ -78,7 +80,7 @@ $ chisel client https://chisel-demo.herokuapp.com 3000
7880

7981
and then visit [localhost:3000](http://localhost:3000/), we should see a directory listing. Also, if we visit the [demo app](https://chisel-demo.herokuapp.com) in the browser we should hit the server's default proxy and see a copy of [example.com](http://example.com).
8082

81-
### Usage
83+
## Usage
8284

8385
<!-- render these help texts by hand,
8486
or use https://github.com/jpillora/md-tmpl
@@ -373,7 +375,7 @@ chisel client --fingerprint 'rHb55mcxf6vSckL2AezFV09rLs7pfPpavVu++MF7AhQ=' <serv
373375
4. Now you have an encrypted, authenticated SOCKS5 connection over HTTP
374376

375377

376-
### Caveats
378+
#### Caveats
377379

378380
Since WebSockets support is required:
379381

@@ -383,15 +385,15 @@ Since WebSockets support is required:
383385
- Openshift has full support though connections are only accepted on ports 8443 and 8080
384386
- Google App Engine has **no** support (Track this on [their repo](https://code.google.com/p/googleappengine/issues/detail?id=2535))
385387

386-
### Contributing
388+
## Contributing
387389

388390
- http://golang.org/doc/code.html
389391
- http://golang.org/doc/effective_go.html
390392
- `github.com/jpillora/chisel/share` contains the shared package
391393
- `github.com/jpillora/chisel/server` contains the server package
392394
- `github.com/jpillora/chisel/client` contains the client package
393395

394-
### Changelog
396+
## Changelog
395397

396398
- `1.0` - Initial release
397399
- `1.1` - Replaced simple symmetric encryption for ECDSA SSH
@@ -402,6 +404,6 @@ Since WebSockets support is required:
402404
- `1.6` - Added client stdio support (by @BoleynSu)
403405
- `1.7` - Added UDP support
404406

405-
### License
407+
## License
406408

407409
[MIT](https://github.com/jpillora/chisel/blob/master/LICENSE) © Jaime Pillora

0 commit comments

Comments
 (0)