feat: rewrite readme instructions

This commit is contained in:
Will Clarke committed 2022-05-30 17:55:54 +01:00
1 parent 677529529e
commit 94b9c76ad3
1 file changed
+10 -5
+10 -5
View File
@@ -9,12 +9,17 @@ A free subdomain provider for developers around the globe.
- [runs-on.tech](https://github.com/aakhilv/runs-on.tech)
### How to get your domain:
- Fork this repository
- Add a new `sub-logs/your-domain-name.json` file directory to register your domain name (`your-domain.is-a-good.dev`)
- Read the [documentation](https://docs.is-a-good.dev/format) on the different `.json` layouts.
- Make a pull request
- Once your pull request has been merged, enjoy your free subdomain!
- Fork [this](https://github.com/is-a-good-dev/Register) repository.
- Create a new file under the `sub-logs` directory.
- Name the file according to the sub-domain name that you would like, for example `will.json`
*The file path and name should look somewhat similar to this: `sub-logs/example.json`*
- Read the format documentation [here](https://docs.is-a-good.dev/format) to see what json format you should be following.
- Check over your file to make sure that everything looks right.
- Make your pull request.
- Check up on your pull request. Sometimes we will comment or add a new label, these can mean that you domain is unavailable or something is wrong with the json. If this is the case, don't worry! You are still able to get a domain, but you may have to either change the file name or check over the json again.
- Leave the rest down to us, we will make sure that the domain is sorted out.
- Once your pull request has been merged, enjoy the sub-domain. If you ever need to change the sub-domain, don't hesitate to open a new pull request to change any of the details.
### Errors:
Your pull request **will not** be merged if: