diff --git a/README.md b/README.md index 02f5e6396..744959b61 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,24 @@

+

TorrentPier

+

- Slack - Crowdin - Scrutinizer - Codacy -
- SensioLabs Insight - Travis - CircleCI - Codecov + Bull-powered BitTorrent tracker engine. +
+

+ +

+ License + Stars Packagist + Downloads + Version + Last release + Size

## About TorrentPier TorrentPier — bull-powered BitTorrent tracker engine, written in php. High speed, simple modification, high load -architecture, built-in support for alternative compiled announcers (Ocelot, XBT). In addition we have very helpful +architecture, built-in support for alternative compiled announcers (Ocelot, XBT). In addition, we have very helpful [official support forum](https://torrentpier.com/forum), where among other things it is possible to test the live demo, get any support and download modifications for engine. @@ -33,20 +37,21 @@ and go from there. The documentation will be translated into english in the near ## Installation -For installation you need to follow a few simple steps: +For installation, you need to follow a few simple steps: -1. Unpack to the server the contents of the downloaded folder -1. Install [Composer](https://getcomposer.org/) and run `composer install` on the downloaded directory -1. Create database and import dump located at **install/sql/mysql.sql** -1. Edit database configuration settings in the configuration file or a local copy (see below) -1. Edit domain name in the configuration file or a local copy (see below) -1. Edit domain ssl setting in the configuration file or a local copy (see below) -1. Edit this files: +1. Install [Composer](https://getcomposer.org/) +2. Run `composer create-project torrentpier/torrentpier` +3. After run `composer install` on the project directory +4. Create database and import dump located at **install/sql/mysql.sql** +5. Edit database configuration settings in the configuration file or a local copy (see below) +6. Edit domain name in the configuration file or a local copy (see below) +7. Edit domain ssl setting in the configuration file or a local copy (see below) +8. Edit this files: 1. **favicon.png** (change on your own) - 1. **robots.txt** (change the addresses in lines **Host** and **Sitemap** on your own) - 1. **opensearch_desc.xml** (change the description and address on your own) - 1. **opensearch_desc_bt.xml** (change the description and address on your own) -1. Log in to the forum with admin/admin login/password and finish setting up via admin panel + 2. **robots.txt** (change the addresses in lines **Host** and **Sitemap** on your own) + 3. **opensearch_desc.xml** (change the description and address on your own) + 4. **opensearch_desc_bt.xml** (change the description and address on your own) +9. Log in to the forum with admin/admin login/password and finish setting up via admin panel ## Access rights on folders and files @@ -96,4 +101,4 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available, ## License -This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details +This project is licensed under the MIT License - see the [LICENSE](https://github.com/torrentpier/torrentpier/blob/master/LICENSE) file for details