diff --git a/README.md b/README.md index 01cd049c..eeeed83d 100755 --- a/README.md +++ b/README.md @@ -1,18 +1,15 @@ -# phpvms 7 +# phpVMS 7 [![Build Status](https://travis-ci.org/nabeelio/phpvms.svg)](https://travis-ci.org/nabeelio/phpvms) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d668bebb0a3c46bda381af16ce3d9450)](https://www.codacy.com/app/nabeelio/phpvms?utm_source=github.com&utm_medium=referral&utm_content=nabeelio/phpvms&utm_campaign=Badge_Grade) [![Latest Stable Version](https://poser.pugx.org/nabeel/phpvms/v/stable)](https://packagist.org/packages/nabeel/phpvms) ![StyleCI](https://github.styleci.io/repos/93688482/shield?branch=dev) [![License](https://poser.pugx.org/nabeel/phpvms/license)](https://packagist.org/packages/nabeel/phpvms) -The next phpvms version built on the laravel framework. work in progress. The latest documentation, with installation instructions is available - [on the phpVMS documentation](http://docs.phpvms.net/) page. +The next phpvms version built on the laravel framework. work in progress. The latest documentation, with installation instructions is available [on the phpVMS documentation](https://docs.phpvms.net/) page. -# installation +## Installation A full distribution, with all of the composer dependencies, is available at this [GitHub Releases](https://github.com/nabeelio/phpvms/releases) link. - - -## Requirements +### Requirements - PHP 7.3+, extensions: - cURL @@ -24,16 +21,16 @@ A full distribution, with all of the composer dependencies, is available at this - Database: - MySQL 5.5+ (or MySQL variant, including MariaDB and Percona) -[View more details on requirements](http://docs.phpvms.net/setup/requirements) +[View more details on requirements](https://docs.phpvms.net/requirements) -## Installer +### Installer 1. Upload to your server 1. Visit the site, and follow the link to the installer -[View installation details](http://docs.phpvms.net/setup/installation) +[View installation details](https://docs.phpvms.net/installation/installation) -# development environment +## Development Environment A full development environment can be brought up using Docker: @@ -50,7 +47,7 @@ Then go to `http://localhost`. If you're using dnsmasq, the `app` container is l 127.0.0.1 phpvms.test ``` -## Building JS/CSS assets +### Building JS/CSS assets Yarn is required, run: