Skip to content

Commit d000837

Browse files
committed
docs: rewrite Evidence README
1 parent 4dba3fc commit d000837

1 file changed

Lines changed: 5 additions & 40 deletions

File tree

evidence/README.md

Lines changed: 5 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,13 @@
1-
# Evidence Template Project
1+
# Evidence dashboard
22

3-
## Using Codespaces
4-
5-
If you are using this template in Codespaces, click the `Start Evidence` button in the bottom status bar. This will install dependencies and open a preview of your project in your browser - you should get a popup prompting you to open in browser.
6-
7-
Or you can use the following commands to get started:
3+
To get up-and-running:
84

95
```bash
106
npm install
11-
npm run sources
12-
npm run dev -- --host 0.0.0.0
13-
```
14-
15-
See [the CLI docs](https://docs.evidence.dev/cli/) for more command information.
16-
17-
**Note:** Codespaces is much faster on the Desktop app. After the Codespace has booted, select the hamburger menu → Open in VS Code Desktop.
18-
19-
## Get Started from VS Code
20-
21-
The easiest way to get started is using the [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Evidence.evidence-vscode):
22-
237

8+
# the destination filename is important
9+
cp /path/to/your_database.sqlite sources/renovate/dashboard.sqlite
2410

25-
1. Install the extension from the VS Code Marketplace
26-
2. Open the Command Palette (Ctrl/Cmd + Shift + P) and enter `Evidence: New Evidence Project`
27-
3. Click `Start Evidence` in the bottom status bar
28-
29-
## Get Started using the CLI
30-
31-
```bash
32-
npx degit evidence-dev/template my-project
33-
cd my-project
34-
npm install
3511
npm run sources
36-
npm run dev
12+
npm run dev
3713
```
38-
39-
Check out the docs for [alternative install methods](https://docs.evidence.dev/getting-started/install-evidence) including Docker, Github Codespaces, and alongside dbt.
40-
41-
42-
43-
## Learning More
44-
45-
- [Docs](https://docs.evidence.dev/)
46-
- [Github](https://github.com/evidence-dev/evidence)
47-
- [Slack Community](https://slack.evidence.dev/)
48-
- [Evidence Home Page](https://www.evidence.dev)

0 commit comments

Comments
 (0)