Skip to content

Commit

Permalink
- Updated README file
Browse files Browse the repository at this point in the history
- Updated issue template files
  • Loading branch information
baxy committed Nov 22, 2018
1 parent 478c1b2 commit 9260e67
Show file tree
Hide file tree
Showing 8 changed files with 119 additions and 99 deletions.
26 changes: 26 additions & 0 deletions .github/BUG_REPORT_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Create a report to help us improve
---

#### Describe the bug
A clear and concise description of what the bug is.

#### To Reproduce
Steps to reproduce the behavior.

#### Expected behavior
A clear and concise description of what you expected to happen.

#### Screenshots
If applicable, add screenshots to help explain your problem.

#### Environment (please complete the following information):
* OS name: [e.g. Linux, OSX, Windows]
* OS version [e.g. 22]
* Ethereum node name: [e.q. Geth, Parity]
* Ethereum node version: [e.q. 1.2.3]
* ethstas-cli version: [e.g. 1.2.3]

#### Additional context
Add any other context about the problem here.
14 changes: 14 additions & 0 deletions .github/FEATURE_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Feature request
about: Suggest an idea for this project
---

#### Feature Request
A clear and concise description of the feature.

#### Acceptance Criteria
A clear and concise description of the acceptance criteria.

#### Benefits:
* Benefit 1...
* Benefit 2...
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Pull request
about: Request to merge Changes / Bug fixes / New features
---

#### Link to issue number:

#### Summary of the issue:

#### Description of how this pull request fixes the issue:

#### Testing performed:

#### Known issues with pull request:

#### Change log entry:

Section: Changes, Bug fixes, New features
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Changelog
All notable changes to this project will be documented in this file.

## [2.4.8] - 2018-11-22
- Updated README file
- Updated issue template files

## [2.4.7] - 2018-11-20
- Dependency packages update

Expand Down
22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
- [Daemon](#daemon)
- [With PM2](#with-pm2)
- [In Docker](#in-docker)
- [Troubleshooting](#troubleshooting)
- [License](#license)

- [Troubleshooting](https://github.com/Alethio/ethstats-cli/blob/master/TROUBLESHOOTING.md)
- [Changelog](https://github.com/Alethio/ethstats-cli/blob/master/CHANGELOG.md)
- [License](https://github.com/Alethio/ethstats-cli/blob/master/LICENSE)

# Getting started

Expand Down Expand Up @@ -81,7 +81,7 @@ Either follow the on screen instructions or see [CLI options](#cli-options) for
The app is configured by default to connect to an Ethereum node on the local machine (http://localhost:8545) that is running on the `mainnet` network.
To connect to a node running on another host see `--client-url` under [CLI options](#cli-options).

After the setup is done, your node will be visible on [ethstats.io](https://alpha.ethstats.io/)
After the setup is done, your node will be visible on [net.ethereum.ethstats.io](https://net.ethereum.ethstats.io/)

IMPORTANT: To be able to extract all statistics from the Ethereum node we recommend running the app on the same host. The usage information about the node like cpu and memory load cannot be extracted if on a different host.

Expand Down Expand Up @@ -230,19 +230,7 @@ docker stop ethstats-cli && docker rm ethstats-cli
then run it again.
## Troubleshooting
#### NPM global package permissions problem
We recommend installing NPM global packages **without** sudo. If you encountered issues when tried to install `ethstats-cli` as a global package with or without sudo regarding permissions, we recommend using this script [npm-global-no-sudo](https://github.com/baxy/npm-global-no-sudo) to fix the issue.
#### Binaries not found
If you installed `ethstats-cli` as a global package with Yarn and the binaries are not found, we recommend running the following command:
```
export PATH="$PATH:`yarn global bin`" && echo 'export PATH="$PATH:`yarn global bin`"' >> ~/.profile
```
## License
MIT © [alethio](https://aleth.io)
MIT © [Alethio](https://aleth.io)
[npm-image]: https://badge.fury.io/js/ethstats-cli.svg
[npm-url]: https://npmjs.org/package/ethstats-cli
Expand Down
103 changes: 51 additions & 52 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ethstats-cli",
"version": "2.4.7",
"version": "2.4.8",
"description": "EthStats CLI client",
"homepage": "https://github.com/EthStats/ethstats-cli",
"author": {
Expand Down

0 comments on commit 9260e67

Please sign in to comment.