Doco and package name - Githubissues

XRPLF / xrpl4j

A 100% Java implementation to interact with the XRP Ledger.

ISC License

86 stars 48 forks source link

Doco and package name #1

Closed RichardAH closed 3 years ago

RichardAH commented 3 years ago

Hey guys Really nice work on this library Few small things:

Package names should be org.xrplf.* not com.ripple.*
Some (maybe all?) readmes contain broken links, e.g. the links in this one: https://github.com/XRPLF/xrpl4j/blob/main/xrpl4j-keypairs/README.md
Readmes in each package should probably have at least one sample/example usage if not more

nkramer44 commented 3 years ago

@RichardAH I think we are going with org.xrpl for the package names.

I fixed the broken links in READMEs, and I have it in my backlog to improve documentation overall. Right now we're mainly focused on getting something released so that people internal to Ripple can start playing with the library.

Here is the PR https://github.com/XRPLF/xrpl4j/pull/3

sappenin commented 3 years ago

This is complete. Plz reopen if there are still issues or changes that you see (note that the library is WIP, still a lot of cleanup todo, coming this week).