From d805604cb1bd74b15b6a40f7607c1ba57747b698 Mon Sep 17 00:00:00 2001 From: Kristian Polso Date: Thu, 10 May 2018 16:06:12 +0300 Subject: [PATCH] Closes #23 --- CONTRIBUTING.md | 19 +++++++++++++++++++ README.md | 47 ++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 61 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2b5be73 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing + +This project follows the global contributing standards for all LBRY projects, to read those go [here](https://lbry.io/faq/contributing) + +You can contribute to this project by [creating a pull request](https://help.github.com/articles/creating-a-pull-request/). + +Want to contribute by editing the text content on the site? This is easy, as all the pages are hosted as markdown files. Just use the "Edit this page on Github" found at the bottom of every page on the website. + +## Code Overview + +This project is a Vuepress-based static documentation website. This includes both the backend and frontend of the website at [beta.lbry.tech](https://beta.lbry.tech). All of this packaged and build with [Yarn](https://yarnpkg.com). + +### Backend + +Backend is handled by Node.js + Express. Currently all backend functionality is in one file, [server.js](server.js). It serves the static files generated by Vuepress. Additionally, it works as a proxy for some basic LBRY daemon method calls at daemon.lbry.tech. + +### Frontend + +[Vuepress](https://vuepress.vuejs.org/) generates static files based on the .vuepress folder and various markdown files in the root of the project. It automatically compiles JS and SCSS found in Vue components in .vuepress folder. \ No newline at end of file diff --git a/README.md b/README.md index 9051b55..cb5bfca 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,40 @@ home: true title: LBRY.tech --- -# LBRY.tech website +# LBRY.tech Website -Technical documentation website for [the LBRY protocol](https://lbry.io/). +Technical documentation website for [the LBRY protocol](https://lbry.io/) made with Javascript. -Built with: +Notable tools used: * [Vue.js](https://vuejs.org/) * [Vuepress](https://vuepress.vuejs.org/) -* [Vuetify](https://vuetifyjs.com/) * [Highlight.js](https://highlightjs.org/) -## Build Setup +![Screenshot of LBRY.tech](https://spee.ch/f/lbry-tech-screenshot.png) + +## Installation + +This project is not designed to be installed directly. Continue reading below to learn how to use this project. + +## Usage + +Visit [beta.LBRY.tech](https://beta.lbry.tech) for hosted version for this repository. + +## Running from Source + +### Prequisities + +* [Node](https://nodejs.org/) (version >= 9) +* [Yarn](https://yarnpkg.com/) +* [Vuepress](https://vuepress.vuejs.org/) + +### Compiling ``` bash +# clone git project +git clone https://github.com/lbryio/lbry.tech + # install dependencies yarn @@ -25,3 +45,20 @@ vuepress dev # build for production with minification & start express server yarn start +``` + +## Contributing + +Contributions to this project are welcome, encouraged, and compensated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +This project is MIT licensed. For the full license, see [LICENSE](LICENSE) + +## Security + +We take security seriously. Please contact [security@lbry.io](mailto:security@lbry.io) regarding any security issues. [Our PGP key is here](https://keybase.io/lbry/key.asc) if you need it. + +## Contact + +The primary contact for this project is [@kauffj](https://github.com/kauffj) \ No newline at end of file