Skip to content

Commit 54f2481

Browse files
authored
Update Readme and Bug Report (#94)
* Cosmetic updates to README.md * update documentation copy in README.md * update README.md * Update README.md image link * update bug report
1 parent 269e897 commit 54f2481

File tree

2 files changed

+63
-50
lines changed

2 files changed

+63
-50
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+18-22
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,28 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
**Describe the bug**
1211

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
12+
From a high level, describe the problem you ran into.
1913

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
14+
**Machine (please complete the following information):**
2215

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
25-
26-
**Desktop (please complete the following information):**
2716
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
17+
- CLI Version [e.g. 22]
18+
19+
**To Reproduce**
20+
21+
What can we do to reproduce your bug?
22+
23+
Please provide:
24+
- Relevent CLI commands
25+
- Relevent environment details
26+
27+
**Expected behavior**
28+
What did you expect to happen?
3029

31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
30+
**Screenshots**
31+
If applicable, add screenshots to help explain your problem. (Be sure to scrub any sensitive information.)
3632

37-
**Additional context**
33+
**Additional context**
3834
Add any other context about the problem here.

README.md

+45-28
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,48 @@
1-
# Meroxa CLI
1+
<img src="https://meroxa-public-assets.s3.us-east-2.amazonaws.com/MeroxaTransparent%402x.png" alt="Meroxa" width="300">
22

3+
We believe that anyone should be empowered to leverage real-time data. Using the Meroxa CLI, you can build data infrastructure in minutes not months.
4+
5+
[Website](https://meroxa.io) |
6+
[Documentation](https://docs.meroxa.com/) |
7+
[Installation Guide](https://docs.meroxa.com/docs/installation-guide) |
8+
[Contribution Guide](CONTRIBUTING.md) |
9+
[Twitter](https://twitter.com/meroxadata)
310

411
## Documentation
512

6-
Our Meroxa CLI is documented publicly in https://docs.meroxa.com/docs, but on each build we also generate Markdown files for each command, exposing the available commands and help for each one. Check them out at [docs/commands/meroxa](docs/commands/meroxa.md).
13+
Meroxa is documented publicly in https://docs.meroxa.com/docs, but on each build we also generate Markdown files for each command, exposing the available commands and help for each one. Check it out at [docs/commands/meroxa](docs/commands/meroxa.md).
714

8-
## Our commands
15+
## Contributing
916

10-
All commands start with `meroxa` which is the name of the binary.
17+
For a complete guide to contributing to the Meroxa CLI, see the [Contribution Guide](CONTRIBUTING.md).
1118

12-
### Build
19+
## Installation Guide
1320

14-
Build CLI as `meroxa` binary:
21+
Please follow the installation instructions in the [Meroxa Documentation](http://docs.meroxa.com/).
1522

16-
```
17-
make build
18-
```
23+
### Build and Install the Binaries from Source (Advanced Install)
1924

20-
## Linting
25+
Currently, we provide pre-built Meroxa binaries for macOS (Darwin) Windows, and Linux architectures.
2126

22-
If you want to make sure everything's correct before pushing to GitHub, you'll need to install [`golangci-lint`](https://golangci-lint.run/) and run:
27+
See [Releases](https://github.com/meroxa/cli/releases).
2328

24-
```
25-
$ golangci-lint run
26-
```
29+
Prerequisite Tools:
2730

28-
Example:
31+
* [Git](https://git-scm.com/)
32+
* [Go](https://golang.org/dl/)
33+
34+
To build from source:
35+
36+
1. The CLI depends on [meroxa-go](github.com/meroxa/meroxa-go) (which is currently a private repo). To update vendoring the dependency, you'll need to run the following:
2937

3038
```
31-
❯ golangci-lint run
32-
cmd/display.go:60:6: `appendCell` is unused (deadcode)
33-
func appendCell(cells []*simpletable.Cell, text string) []*simpletable.Cell {
34-
^
39+
make gomod
3540
```
3641

37-
## Vendor
38-
39-
The CLI depends on [meroxa-go](github.com/meroxa/meroxa-go) which is currently
40-
a private repo. To update vendoring the dependency, you'll need to run the following:
42+
2. Build CLI as `meroxa` binary:
4143

4244
```
43-
make gomod
45+
make build
4446
```
4547

4648
## Release
@@ -52,12 +54,27 @@ git tag is pushed to the repo.
5254
* Tag - `git tag -a vX.X.X -m "<message goes here>"`
5355
* Push - `git push origin vX.X.X`
5456

55-
## Tests
57+
## Linting
58+
59+
If you want to make sure everything's correct before pushing to GitHub, you'll need to install [`golangci-lint`](https://golangci-lint.run/) and run:
5660

5761
```
58-
make test
62+
$ golangci-lint run
5963
```
6064

61-
## Contributing
65+
Example:
6266

63-
See [CONTRIBUTING.md](/CONTRIBUTING.md).
67+
```
68+
❯ golangci-lint run
69+
cmd/display.go:60:6: `appendCell` is unused (deadcode)
70+
func appendCell(cells []*simpletable.Cell, text string) []*simpletable.Cell {
71+
^
72+
```
73+
74+
## Tests
75+
76+
To run the test suite:
77+
78+
```
79+
make test
80+
```

0 commit comments

Comments
 (0)