Merge pull request #331 from open-domains/WilliamDavidHarrison-patch-1

docs(readme): add CLI registration
This commit is contained in:
andrewstech authored and GitHub committed 2023-06-04 09:42:06 +01:00
commit f4e840dc44
1 file changed
+22 -1
+22 -1
View File
@@ -63,7 +63,28 @@ This will hopefully be fixed soon.
[ssl-full]:https://developers.cloudflare.com/ssl/origin-configuration/ssl-modes/full
[caching-levels]:https://developers.cloudflare.com/cache/how-to/set-caching-levels
## Register a Domain
## Register
### CLI (*recommended*)
1. Install the CLI using this command:
```
npm install @open-domains/cli -g
```
2. Login to the CLI:
```
open-domains login
```
3. Register a domain and follow the steps:
```
open-domains register
```
### Manual
1. **Star** and **[Fork](https://github.com/open-domains/register/fork)** this repository.
2. Add a new file called `example.domain.json` in the `/domains` folder to register `example` subdomain.
3. Edit the file (below is just an **example**, provide a **valid** JSON file with your needs, the format is very strict.