Skip to content

Commit

Permalink
Other README/CONTRIBUTING tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
fdocr committed Dec 5, 2023
1 parent e2a426f commit 82f0fd5
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ If you implemented a bugfix, a new feature, or updated the docs/tests feel free

1. Fork the repository
1. Install the dependencies & run locally
- `bundle install`
- `bundle exec puma -p 4567`
- `shards install`
- `crystal run src/server.cr`
1. Create your feature branch
- `git checkout -b my-new-feature`
1. Work on your fix/feature
- Add tests to avoid regressions in the future
1. Run the tests
- `bundle exec rspec`
- `KEMAL_ENV=test crystal spec`
- `SAFELIST="fdo.cr github.com" KEMAL_ENV=test crystal spec`
1. Commit your changes
- `git commit -am 'Added some feature'`
1. Push to the branch
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If this service adds value to you or your company please consider sponsoring me

## Self host

The project makes it easy for you to self host an UDL Server. The easiest and recommended way to do this is to:
The project makes it easy for you to self host a UDL Server. The easiest and recommended way to do this is to:

1. Fork this repository
1. Configure a PaaS to automatically deploy from your fork repository
Expand All @@ -63,7 +63,7 @@ The project makes it easy for you to self host an UDL Server. The easiest and re

Alternatively you can run the lightweight [`fdocr/udl-server`](https://hub.docker.com/repository/docker/fdocr/udl-server/general) Docker container on your own. At the time of this writing the docker image is only about `26.3 MB` in size (`10.87 MB` compressed).

### Troubleshooting
## Troubleshooting

Some common details to keep in mind in case your redirects aren't working properly:

Expand All @@ -80,7 +80,7 @@ The project is now ported to [Crystal](https://crystal-lang.org/) and [Kemal fra

![diagram](nanosecond-response-times.png)

I'm aiming to work on adding a bunch of other features to the project and [share blog posts](https://fdo.cr/blog) with walkthroughs/benchmarks/etc. Feel free to tag along and submit feature requests in the issue tracker!
I'm aiming to work on adding a bunch of other features to the project and [share blog posts](https://fdo.cr/blog) with walkthroughs/benchmarks/etc. Feel free to tag along and submit feature requests in the issue tracker.

## Contributing

Expand Down

0 comments on commit 82f0fd5

Please sign in to comment.