Skip to content

Commit

Permalink
docs: move TL;DR; up
Browse files Browse the repository at this point in the history
  • Loading branch information
cristianoliveira committed Apr 13, 2024
1 parent d7e4554 commit e322344
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@

See more on [examples](https://github.com/cristianoliveira/ergo/tree/master/examples)

## TL;DR;
```bash
python3 -m http.server 8800 &
echo "http://localhost:8800 mylocalsite" > .ergo
ergo local & # may need sudo since it binds to port 80
curl http://mylocalsite.localhost
```

## Summary
* [Philosophy](#philosophy)
* [Installation](#installation)
Expand Down Expand Up @@ -130,15 +138,6 @@ Make sure you have `$GOPATH/bin` in your path: `export PATH=$PATH:$GOPATH/bin`

## Usage

### TL;DR;
```bash
python3 -m http.server 8800 &
echo "http://localhost:8800 mylocalsite" > .ergo
ergo local & # may need sudo since it binds to port 80
curl http://mylocalsite.localhost
```
---

Ergo looks for a `.ergo` file inside the current directory. It must contain the names and URL of the services following the same format as `/etc/hosts` (`domain`+`space`+`url`). The main difference is it also considers the specified port.

### Subdomains for localhost
Expand Down

0 comments on commit e322344

Please sign in to comment.