diff --git a/code-of-conduct.md b/code-of-conduct.md index 5f14a59..0638973 100644 --- a/code-of-conduct.md +++ b/code-of-conduct.md @@ -1,17 +1,3 @@ - - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct) - - [Our Pledge](#our-pledge) - - [Our Standards](#our-standards) - - [Our Responsibilities](#our-responsibilities) - - [Scope](#scope) - - [Enforcement](#enforcement) - - [Attribution](#attribution) - - - # Contributor Covenant Code of Conduct ## Our Pledge diff --git a/contributing.md b/contributing.md index 673ed8a..d14c33d 100644 --- a/contributing.md +++ b/contributing.md @@ -1,12 +1,3 @@ - - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [Contribution Guidelines](#contribution-guidelines) - - [Updating your PR](#updating-your-pr) - - - # Contribution Guidelines Please note that this project is released with a @@ -17,7 +8,7 @@ project you agree to abide by its terms. Ensure your pull request adheres to the following guidelines: -- Run `doctoc` on the repo to generate an updated table-of-contents (if adding a new section) +- Run `doctoc README.md` on the repo to generate an updated table-of-contents (if adding a new section) - Doctoc can be found [here](https://github.com/thlorenz/doctoc). - Ensure that any suggestions are directly related to the Lightning Network diff --git a/readme.md b/readme.md index 493ebdf..dd5c85f 100644 --- a/readme.md +++ b/readme.md @@ -4,34 +4,82 @@ ## Contents - -- [Section](#section) -- [Another Section](#another-section) - - [Subsection](#subsection) +- [Lightning Network Protocol](#lightning-network-protocol) + - [Implementations](#implementations) + - [Specifications](#specifications) +- [Applications](#applications) + - [Desktop Interfaces](#desktop-interfaces) + - [Web Interfaces](#web-interfaces) + - [Misc](#misc) +- [Developer Resources](#developer-resources) + - [Talks](#talks) + - [Tutorials](#tutorials) +- [Community](#community) - [Contribute](#contribute) - [License](#license) -## Section +## Lightning Network Protocol -About this section. Optional. Keep this short and focus on the list. +### Implementations -- [List item](http://example.com) -- [List item](http://example.com) +Implementations of the Lightning Network Protocol +- [LND](https://github.com/lightningnetwork/lnd) - Lightning Network Daemon (Golang) +- [eclair](https://github.com/ACINQ/eclair) - A scala implementation of the Lightning Network (Scala) +- [lit](https://github.com/mit-dci/lit) - Lightning Network node software (Golang) +- [c-lightning](https://github.com/ElementsProject/lightning) - A Lightning Network implementation in C -## Another Section +### Specifications -### Subsection +- [Lightning Network Specification](https://github.com/lightningnetwork/lightning-rfc) +- [LND API Reference](http://api.lightning.community/) +- [Lightning Network White Paper](https://lightning.network/lightning-network-paper.pdf) -- [List item](http://example.com) -- [List item](http://example.com) +## Applications + +### Desktop Interfaces + +- [lnd-gui](https://github.com/alexbosworth/lnd-gui) - Lightning MacOS GUI Wallet +- [zap-desktop](https://github.com/LN-Zap/zap-desktop) - Lightning Network desktop application + +### Web Interfaces + +- [lncli-web](https://github.com/mably/lncli-web) - Light-weight web client for the lnd daemon written in NodeJS / Angular +- [lnd-chrome-extension](https://chrome.google.com/webstore/detail/lnd-chrome-extension/fckoopaejbdhcjgpjllghoadkeicdjnf?hl=en) + +### Misc + +- [ln-dice](https://github.com/mably/ln-dice) - Dice gambling service using the Lightning Network for deposits and withdrawals + +## Developer Resources + +- [Lightning Network Developers Site](http://dev.lightning.community/) +- [Lightning Network Developer Guide](http://dev.lightning.community/guides/) + +### Talks + +- [SF Bitcoin Devs Seminar: Scaling Bitcoin to Billions of Transactions Per Day](https://www.youtube.com/watch?v=8zVzw912wPo) + +### Tutorials + +- [Setting up and Testing LND with the Testnet Lightning Faucet](http://lightning.community/lnd/faucet/2017/01/19/lightning-network-faucet/) +- [Setting up a local Lightning cluster](http://dev.lightning.community/tutorial/01-lncli/index.html) +- [Using the LND Web Client](http://dev.lightning.community/tutorial/02-web-client/index.html) +- [Using the LND gRPC Client](http://dev.lightning.community/tutorial/03-rpc-client/index.html) +- [Integrating Lightning into a server-side web applicaiton](http://dev.lightning.community/tutorial/04-webapp-integration/index.html) + +## Community + +- [Lightning Network Community Blog](http://lightning.community/) +- [Lightning Network Twitter Feed](https://twitter.com/lightning) +- [Lightning Network Mailing List](https://lists.linuxfoundation.org/mailman/listinfo/lightning-dev) ## Contribute