Skip to content
This repository was archived by the owner on Apr 24, 2024. It is now read-only.

Commit a6cbfd3

Browse files
committed
📝 updated readme
1 parent d16279b commit a6cbfd3

1 file changed

Lines changed: 4 additions & 7 deletions

File tree

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Create ChartBrew App
22

3-
A CLI tool for [📈 ChartBrew](https://github.com/razvanilin/chartbrew)
3+
A CLI tool for [📈 Chartbrew](https://github.com/razvanilin/chartbrew)
44

55
## 🚀 Get started
66

@@ -10,16 +10,13 @@ npx create-chartbrew-app myApp
1010

1111
## 👨‍💻 Arguments
1212

13-
The CLI tool can create a `.env` file for you to get started right away. Just pass any of of the options below.
13+
Run the command below and complete fill in the details as you are prompted. You will need to have MySQL running and prepare an empty database that Chartbrew can use.
1414

1515
```sh
16-
npx create-chartbrew-app cbTest1 --dbname="chartbrewy" --dbhost="localhost" --dbport="3306" --dbusername="raz" --dbpassword="secretStuff"
16+
npx create-chartbrew-app chartbrew
1717
```
1818

19-
There are two `.env` files that need to be set with the database authentication parameters. If you haven't used the parameters above when you ran the command, create those files manually by following the templates found at:
20-
21-
* `server/.env-template`
22-
* `server/models/.env_template`
19+
The CLI tool creates a `chartbrew/.env` file which you can configure at any time if you want to change the database, API & client host, etc. The file contains comments explaining what each environmental variable is for.
2320

2421
## 📦 Update an existing project
2522

0 commit comments

Comments
 (0)