Browse Source

added read me with contribution info

beginners-guide
Bucko 7 years ago
parent
commit
2234eb7ea3
  1. 9
      README.md
  2. 2
      page-templates/guides-archive.html

9
README.md

@ -0,0 +1,9 @@
# About Bcoin.io
Bcoin is the first fullnode Bitcoin implementation built specifically for production systems at scale. Originally created to be used as backend infrastructure for [Purse.io](https://purseio), Bcoin enables companies to spin up consumer-grade bitcoin applications/wallet systems without the long-term concern of scalability, and security. Engineered from the ground-up in Nodejs to create scalable, flexible, and efficient production-ready systems. Bcoin can be integrated into almost any desktop or browser application to enable native payments, using bitcoin’s trusted and robust global network.
# Guide Contribution Guidelines
## Submitting Ideas and Claiming Bounties
Have an idea for a guide you'd like to contribute to [our collection of Bitcoin tutorials](http://bcoin.io/guides.html) written with bcoin? Want to collect a bounty for a submitted guide? First head on over to the [GitHub issues](https://github.com/bcoin-org/bcoin-org.github.io/issues) and see if your idea is already posted. Bounties will be placed on issues via [bountysource](https://bountysource.com) and tagged with the "guide" label.
## Adding a New Guide
To add a new guide, just a submit a Pull Request with a markdown file added to the `/guides-markdown` directory in this repo (take a look at some of the other guides already there). Make sure to include a title using a top level header (with a single `#` hashtag in the markdown) and then a `post-author` and `post-description` at the top using code-snippet blocks labeled accordingly. If your PR is accepted, it will automatically be converted to html added to the website and any bounty associated with the GitHub issue will be yours!

2
page-templates/guides-archive.html

@ -293,6 +293,8 @@
<!-- END POST IMAGE -->
<!-- START ARCHIVE -->
<!-- END ARCHIVE -->
<div class="col-sm-11 guide-section-title montserrat text-uppercase bottom-line2">Contribute a Guide</div>
Have a guide you'd like to contribute or a request for one you'd like to see? Head on over to our <a href="https://github.com/bcoin-org/bcoin-org.github.io">GitHub repo</a> to see how you can get involved and earn bounties for published guides!
</div>
<!-- END BLOG CONTENT -->

Loading…
Cancel
Save