README.md: Updates to improve readability

This commit is contained in:
John Gannon 2020-01-09 15:37:13 -05:00
parent 6ed1410821
commit 57c23ef2bc
1 changed files with 17 additions and 18 deletions

View File

@ -21,20 +21,20 @@
### Introduction
[Bagisto](https://www.bagisto.com) is a hand tailored E-Commerce framework designed on some of the hottest opensource technologies
such as [Laravel](https://laravel.com) a [PHP](https://secure.php.net/) framework, [Vue.js](https://vuejs.org)
[Bagisto](https://www.bagisto.com) is a hand tailored E-Commerce framework built on some of the hottest opensource technologies
such as [Laravel](https://laravel.com) (a [PHP](https://secure.php.net/) framework) and [Vue.js](https://vuejs.org)
a progressive Javascript framework.
**Bagisto is viable attempt to cut down your time, cost and workforce for building online stores or migrating from physical stores
to the ever demanding online world. Your business whether small or huge it suits all and very simple to set it up.**
**Bagisto can help you to cut down your time, cost, and workforce for building online stores or migrating from physical stores
to the ever demanding online world. Your business -- whether small or huge -- can benefit. And it's very simple to set it up.**
**Read our documentation: [Bagisto Docs](https://devdocs.bagisto.com/)**
**We are also having a forum for any type of your concern, feature request discussions. Please visit: [Bagisto Forums](https://forums.bagisto.com/)**
**We also have a forum for any type of concerns, feature requests, or discussions. Please visit: [Bagisto Forums](https://forums.bagisto.com/)**
# Visit our live [Demo](https://demo.bagisto.com)
It packs in lots of demanding features that allows your business to scale in no time:
It packs in lots of features that will allow your E-Commerce business to scale in no time:
* Multiple Channels, Locale, Currencies.
* Built-in Access Control Layer.
@ -50,11 +50,10 @@ It packs in lots of demanding features that allows your business to scale in no
* Simple and Configurable Products.
* Price rules (Discount) inbuilt.
* CMS Pages.
* Check out [click here](https://bagisto.com/features/).
* Check out [these features and more](https://bagisto.com/features/).
**For Developers**:
Dev guys can take advantage of two of the hottest frameworks used in this project Laravel and Vue.js, both of these frameworks have been used in Bagisto.
Bagisto is using power of both of these frameworks and making best out of it out of the box.
Take advantage of two of the hottest frameworks used in this project -- Laravel and Vue.js -- both of which have been used in Bagisto.
### Documentation
@ -80,7 +79,7 @@ Bagisto is using power of both of these frameworks and making best out of it out
[Download](https://github.com/bagisto/bagisto/archive/v0.1.6.zip)
##### b. Extract the contents of zip and execute the project in browser:
##### b. Extract the contents of zip and execute the project in your browser:
~~~
http(s)://localhost/bagisto/public
@ -94,15 +93,15 @@ http(s)://example.com/public
**2. Try our old fashioned way to install Bagisto:**
##### Execute these commands below as in their order
##### Execute these commands below, in order
~~~
1. composer create-project bagisto/bagisto
~~~
**Now configure your database:**
**Now, configure your database:**
If the above command was completed successfully, then you'll find directory **bagisto** and all of the code will be inside it.
If the above command was completed successfully, then you'll find directory **bagisto** with all of the code inside it.
Find file **.env** inside **bagisto** directory and set the environment variables listed below:
@ -114,7 +113,7 @@ Find file **.env** inside **bagisto** directory and set the environment variable
* **DB_USERNAME**
* **DB_PASSWORD**
Although, mailer environment variables are also required to be set up as **Bagisto** requires emails to send to customers and admins for various functionalities that are built in.
Mailer environment variables are also required to be set up. This is because **Bagisto** needs to send emails to customers and admins depending on what events require notification.
~~~
2. php artisan migrate
@ -142,13 +141,13 @@ Although, mailer environment variables are also required to be set up as **Bagis
##### On server:
Warning: Before going full on production mode we recommend you to uninstall developer dependencies.
Warning: Before going into production mode we recommend you uninstall developer dependencies.
In order to do that, run the command below:
> composer install --no-dev
~~~
Open the specified entry point in your hosts file in browser or make entry in hosts file if not done.
Open the specified entry point in your hosts file in your browser or make an entry in hosts file if not done.
~~~
##### On local:
@ -178,13 +177,13 @@ password:admin123
Bagisto is a truly opensource E-Commerce framework which will always be free under the [MIT License](https://github.com/bagisto/bagisto/blob/master/LICENSE).
### Security Vulnerabilities
Please don't disclose security vulnerabilities publicly. If you find any security vulnerability in Bagisto then please write us mail: mailto:support@bagisto.com.
Please don't disclose security vulnerabilities publicly. If you find any security vulnerability in Bagisto then please email us: mailto:support@bagisto.com.
### Miscellaneous
#### Contributors
This project is on [Open Collective](https://opencollective.com/bagisto) and it exists thanks to this people who contribute.
This project is on [Open Collective](https://opencollective.com/bagisto) and it exists thanks to the people who contribute.
<a href="https://github.com/bagisto/bagisto/graphs/contributors"><img src="https://opencollective.com/bagisto/contributors.svg?width=890&button=false"/></a>