Skip to content

Commit 1a7e68f

Browse files
authored
style: Enhance README.md with improved styling and formatting (#881)
- Improved header and alignment styling for better visual hierarchy - Added syntax highlighting to code blocks - Enhanced section titles for better readability - Ensured all external links open in new tabs - Used more descriptive alt text for images
1 parent ef1235f commit 1a7e68f

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

README.md

+23-22
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
<div align="center">
2-
<h1>Nhost CLI</h1>
2+
<h1 style="font-size: 3em; font-weight: bold;">Nhost CLI</h1>
33
</div>
44

55
<div align="center">
66

77
[![Go Report Card](https://goreportcard.com/badge/github.com/nhost/cli)](https://goreportcard.com/report/github.com/nhost/cli)
88
<a href="https://twitter.com/nhost" target="_blank" rel="noopener noreferrer">
9-
<img src="https://img.shields.io/twitter/follow/nhost?style=social" />
9+
<img src="https://img.shields.io/twitter/follow/nhost?style=social" alt="Twitter Follow Badge"/>
1010
</a>
1111

1212
</div>
1313

14-
[Nhost](http://nhost.io) is an open source Firebase alternative with GraphQL.
14+
[Nhost](http://nhost.io) is an open-source Firebase alternative with GraphQL.
1515

16-
The Nhost CLI is used to get a local development environment. The local development environment will automatically track database migrations and hasura metadata.
16+
The Nhost CLI is used to set up a local development environment. This environment will automatically track database migrations and Hasura metadata.
1717

1818
It's recommended to use the Nhost CLI and the [Nhost GitHub Integration](https://docs.nhost.io/platform/github-integration) to develop locally and automatically deploy changes to production with a git-based workflow (similar to Netlify & Vercel).
1919

20-
## Services:
20+
## Services
2121

2222
- [Nhost Dashboard](https://github.com/nhost/nhost/tree/main/dashboard)
2323
- [Postgres Database](https://www.postgresql.org/)
@@ -30,33 +30,33 @@ It's recommended to use the Nhost CLI and the [Nhost GitHub Integration](https:/
3030

3131
## Get Started
3232

33-
Install the Nhost CLI:
33+
### Install the Nhost CLI
3434

35-
```
35+
```bash
3636
sudo curl -L https://raw.githubusercontent.com/nhost/cli/main/get.sh | bash
3737
```
3838

39-
Initialize a project:
39+
### Initialize a project
4040

41-
```
41+
```bash
4242
nhost init
4343
```
4444

45-
Initialize a project with a remote project as a starting point:
45+
### Initialize a project with a remote project as a starting point
4646

47-
```
47+
```bash
4848
nhost init --remote
4949
```
5050

51-
Start the development environment:
51+
### Start the development environment
5252

53-
```
53+
```bash
5454
nhost up
5555
```
5656

57-
You can also use the Nhost Dashboard:
57+
### Use the Nhost Dashboard
5858

59-
```
59+
```bash
6060
nhost up --ui nhost
6161
```
6262

@@ -66,15 +66,16 @@ nhost up --ui nhost
6666
- [Nhost CLI](https://docs.nhost.io/platform/cli)
6767
- [Reference](https://docs.nhost.io/reference/cli)
6868

69-
## Build from source
70-
Make sure you have [Go](https://golang.org/doc/install) 1.18 or later installed.
69+
## Build from Source
7170

72-
The source code includes a self-signed certificate for testing purposes
73-
Nhost workers with configured access to AWS may use `cert.sh` script to generate a real certificate from Let's Encrypt.
71+
Make sure you have [Go](https://golang.org/doc/install) 1.18 or later installed.
7472

75-
`go build -o /usr/local/bin/nhost` will build the binary available as `nhost` command in terminal.
73+
The source code includes a self-signed certificate for testing purposes. Nhost workers with configured access to AWS may use the `cert.sh` script to generate a real certificate from Let's Encrypt.
7674

75+
```bash
76+
go build -o /usr/local/bin/nhost
7777
```
78+
This will build the binary available as the `nhost` command in the terminal.
7879

7980
## Dependencies
8081

@@ -83,8 +84,8 @@ Nhost workers with configured access to AWS may use `cert.sh` script to generate
8384
- [curl](https://curl.se/)
8485
- [Git](https://git-scm.com/downloads)
8586

86-
## Supported Platforms:
87+
## Supported Platforms
8788

8889
- MacOS
8990
- Linux
90-
- Windows WSL2
91+
- Windows WSL2

0 commit comments

Comments
 (0)