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

Readme & dev updates #173

Merged
merged 2 commits into from
May 14, 2018
Merged

Readme & dev updates #173

merged 2 commits into from
May 14, 2018

Conversation

kremalicious
Copy link
Contributor

@kremalicious kremalicious commented May 14, 2018

  • update Readme, TOC
  • tweak documentation links
  • remove IPDB references
  • new command: npm run doc, for generating the API.md file
  • new command: npm run dev, for live watching webpack intended for local development
  • JSdoc: make all methods public by default, selectively make some private
  • JSdoc: organize all methods under their class
  • ESlint/JSdoc linting fixes
  • package updates
  • closes (optional) watch process for faster node.js/browser development #30

/cc @manolodewiner

* update TOC
* tweak documentation links
* remnove IPDB references
@codecov-io
Copy link

codecov-io commented May 14, 2018

Codecov Report

Merging #173 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #173   +/-   ##
=======================================
  Coverage   85.99%   85.99%           
=======================================
  Files          11       11           
  Lines         257      257           
=======================================
  Hits          221      221           
  Misses         36       36
Impacted Files Coverage Δ
src/sanitize.js 73.68% <ø> (ø) ⬆️
src/connection.js 92.3% <ø> (ø) ⬆️
src/request.js 92.85% <ø> (ø) ⬆️
src/stringify_as_query_param.js 90% <ø> (ø) ⬆️
src/format_text.js 36.36% <ø> (ø) ⬆️
src/utils/ccJsonLoad.js 100% <ø> (ø) ⬆️
src/Ed25519Keypair.js 100% <ø> (ø) ⬆️
src/utils/ccJsonify.js 80.76% <ø> (ø) ⬆️
src/baseRequest.js 79.31% <ø> (ø) ⬆️
src/transaction.js 97.5% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4570b24...81ef597. Read the comment docs.

* new command: npm run doc, for generating the API.md file
* new command: npm run dev, for live watching webpack
* JSdoc: make all methods public by default, selectively make some private
* JSdoc: organize all methods under their class
* linting fixes
* package updates
@kremalicious kremalicious changed the title readme & API doc updates Readme & dev updates May 14, 2018
@kremalicious kremalicious merged commit 5c106a2 into master May 14, 2018
@kremalicious kremalicious deleted the fix/documentation branch May 14, 2018 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(optional) watch process for faster node.js/browser development
2 participants