Skip to content

Commit

Permalink
update: fix grammar mistakes and add more references
Browse files Browse the repository at this point in the history
small patch
  • Loading branch information
statulr authored Sep 13, 2024
1 parent ae94ae8 commit bf12930
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ statistics about shortened URLs.

## Features
- **Web UI with Golang's** `html/template`:
A minimalistic web interface built using Golang's standard `html/template`
A minimalistic web interface built using [Golang](https://en.wikipedia.org/wiki/Go_(programming_language))'s standard `html/template`
package and [Tailwind](https://tailwindcss.com).

- **URL Click Statistics**:
Expand Down Expand Up @@ -50,14 +50,15 @@ also checks if the URL contains a valid
```bash
curl -i http://localhost:1234/
```
(*These instructions were made for unix/linux based systems, we cannot guarentee these commands will work for other operating systems*)[https://en.wikipedia.org/wiki/Linux_kernel]

### Development

Use the `Makefile` to run/build the web server.

#### Requirements

- [Watchexec](https://github.com/watchexec/watchexec) - A file watcher for restarting and running the web server when the source files is updated
- [Watchexec](https://github.com/watchexec/watchexec) - A file watcher for restarting and running the web server when the source files are updated (Nodemon may work for other people)[https://www.npmjs.com/package/nodemon]
- [Bun](https://bun.sh) - Bun package manager (or `npm`,`pmpm`) for installing and watching static content for tailwind classes

#### Commands
Expand All @@ -68,7 +69,7 @@ Use the `Makefile` to run/build the web server.

## Contributing

We welcome contributions to this project! For guidelines on how to contribute, please refer to the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.
We welcome any contributions to this project! For guidelines on how to contribute, please refer to the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.

## LICENSE

Expand Down

0 comments on commit bf12930

Please sign in to comment.