Update README.md

This commit is contained in:
rn54n 2020-11-27 14:31:40 +01:00 committed by GitHub
parent 511db3f13b
commit 9a6b936c3d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 55 additions and 2 deletions

View File

@ -1,2 +1,55 @@
# bitcoinprivate-website
new repo for redesigned website
# [BitcoinPrivate Website](https://btcprivate.org/)
[![LICENSE](https://img.shields.io/github/license/rn54n/bitcoinprivate-website)](https://github.com/rn54n/bitcoinprivate-website/blob/main/LICENSE.txt)
[![TWITTER](https://img.shields.io/twitter/follow/btcpnews?style=social)](https://img.shields.io/twitter/follow/btcpnews?style=social)
BitcoinPrivate Website is a front-end for the upcoming release of BitcoinPrivate coin. Development on a new chain are in progress and a snapshot happend at 680,000
* Homepage: [https://btcprivate.org](https://btcprivate.org/)
* Origin-Source: [https://github.com/BTCPrivate/bitcoinprivate-website](https://github.com/BTCPrivate/bitcoinprivate-website)
* Twitter: [@bitcoinprivate](https://twitter.com/bitcoinprivate)
* Twitter: [@btcpnews](https://twitter.com/btcpnews)
## Quick start
The following should be considered:
* HTML5, CSS, JavaScript, Bootstrap 4 only
* Simple design and structure
* Max. two clicks until information displayed
* Clone the git repo — `git clone
https://github.com/rn54n/bitcoinprivate-website.git` - and checkout the
[tagged release](https://github.com/rn54n/bitcoinprivate-website/releases)
you'd like to use. The `dist` folder represents the latest version of the
project for end users.
## Browser support
* Chrome *(latest 2)*
* Edge *(latest 2)*
* Firefox *(latest 2)*
* Internet Explorer 11
* Opera *(latest 2)*
* Safari *(latest 2)*
*This doesn't mean that BitcoinPrivate Website cannot be used in older browsers,
we'll ensure compatibility with the ones mentioned above.*
If you need legacy browser support for IE8/IE9/IE10 not supported.
## Documentation
Right now there is no need for a documentation of the website itself.
## Contributing
Anyone is welcome to [contribute](.github/CONTRIBUTING.md), however, if you decide to get
involved, please take a moment to review the [guidelines](.github/CONTRIBUTING.md):
* [Bug reports](.github/CONTRIBUTING.md#bugs)
* [Feature requests](.github/CONTRIBUTING.md#features)
* [Pull requests](.github/CONTRIBUTING.md#pull-requests)
## License
The code is available under the [MIT license](LICENSE.txt).