chore: subtle changes to readme

This commit is contained in:
Will Clarke committed 2022-05-30 17:53:14 +01:00
1 parent 1528866908
commit 677529529e
1 file changed
+7 -16
+7 -16
View File
@@ -1,18 +1,17 @@
## ***is-a-good-dev***
A free subdomain provider for developers around the globe.
### **Inspiration**
This project was heavily inspired by similar projects, check them out below:
- **[is-a-dev](https://github.com/is-a-dev/register)**
- **[js.org](https://github.com/js-org/js.org)**
- **[thedev.id](https://github.com/fransallen/thedev.id)**
**Similar projects include:**
- [is-a.dev](https://github.com/is-a-dev/register)
- [js.org](https://github.com/js-org/js.org)
- [thedev.id](https://github.com/fransallen/thedev.id)
- [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) on the different `.json` layouts.
- 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!
@@ -27,11 +26,3 @@ Your pull request **will not** be merged if:
### **Please make sure that you fill in the relevant information on your pull request, we are currently operating this manually meaning it takes time to link the domains. Filling in the correct information just makes our lives that little bit easier.**
---
## **Upcoming changes:**
- Website
- Interface when visiting root domain to allow easy navigation to website or github repository
- Possible addition of more domains/options
- Possible dashboard
- Automatic processing of domains after pull request is merged