Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md, instructions and first use #2

Closed
dexX7 opened this issue Aug 7, 2015 · 2 comments
Closed

Improve README.md, instructions and first use #2

dexX7 opened this issue Aug 7, 2015 · 2 comments

Comments

@dexX7
Copy link
Member

dexX7 commented Aug 7, 2015

I'm a bit nitpicking here, but a few quick notes about the readme.

  1. The / in the build example seems twisted:
-    .\gradlew bootRun
+    ./gradlew bootRun
  1. The requirements should be stated, in particular that JDK 8 is required. It could be noted that JAVA_HOME must point to the correct version, when using ./gradlew. It might be noted that [a list of packages] is downloaded, which can be relevant for someone with a mobile data connection.

  2. It would be great, if there were a few lines to what could be expected, when running ./gradlew bootRun. Before doing so I was wondering, how to use the project (i.e. I missed a "first use" example, and actually assumed the project focuses on a BitcoinJ RPC server), and then I was surprised for a moment, when I saw the rather wild messages of STOMP, until I noticed they are actually network messages. It was more obvious after the first transactions were listed.

It should be stated that bootRun connects to the P2P network.


Other than that, this is really nice! :)

Edit: just found the other gems, like http://localhost:8080/listPeers (login: admin/admin).

@msgilligan
Copy link
Member

I love your nitpicking @dexX7 -- it shows that you care!

msgilligan added a commit that referenced this issue Aug 7, 2015
@msgilligan
Copy link
Member

Should be resolved in 71397fd. Closing. Let me know if I missed anything. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants