search

rnpgp / rnpgp.github.io

Official RNP site
https://www.rnpgp.com
1 stars 3 forks source link

Add Ruby-RNP documentation and link #2

Open ronaldtse opened 6 years ago

ronaldtse commented 6 years ago

Ruby-RNP: https://github.com/riboseinc/ruby-rnp

Ruby-RNP documentation: https://www.rubydoc.info/github/riboseinc/ruby-rnp/master/toplevel

Mentioned here: https://github.com/riboseinc/ruby-rnp/pull/6#issuecomment-385836048

strogonoff commented 5 years ago

The Ruby-RNP docs is just an API reference. As theme docs point out (and I believe) it’s best to instead link to RubyDoc API reference.

However, what we would want to do additionally (if the goal is to promote the project in the industry) is to provide docs that Ruby-RNP is currently much lacking, namely an overview, a getting started guide and a couple of typical usage tutorials.

In this ticket I’m adding the link to Ruby-RNP and creating the foundation for further docs, for now based on README, later adding sample I’m putting together for the post in https://github.com/riboseinc/rnpgp.com/pull/10. These new docs would be placed into ruby-rnp repo’s docs/ directory, and subsequently get picked up during rnpgp.com build.