Finished refactor of entity repos

[bookstack] / readme.md

diff --git a/readme.md b/readme.md
index 067983e84cb72b2a87a26cee756cb2017a662961..fa5c48fe08b97159cf4e4b527f2cd9f3ca4ce1ce 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -1,31 +1,48 @@
 # BookStack
 
+[![GitHub release](https://img.shields.io/github/release/ssddanbrown/BookStack.svg?maxAge=2592000)](https://github.com/ssddanbrown/BookStack/releases/latest)
+[![license](https://img.shields.io/github/license/ssddanbrown/BookStack.svg?maxAge=2592000)](https://github.com/ssddanbrown/BookStack/blob/master/LICENSE)
+[![Build Status](https://travis-ci.org/BookStackApp/BookStack.svg)](https://travis-ci.org/BookStackApp/BookStack)
+
 A platform for storing and organising information and documentation. General information and documentation for BookStack can be found at https://www.bookstackapp.com/.
 
 * [Installation Instructions](https://www.bookstackapp.com/docs/admin/installation)
 * [Documentation](https://www.bookstackapp.com/docs)
-* [Demo Instance](https://demo.bookstackapp.com) *(Login username: `[email protected]`. Password: `password`)*
+* [Demo Instance](https://demo.bookstackapp.com)
+  * *Username: `[email protected]`*
+  * *Password: `password`*
 * [BookStack Blog](https://www.bookstackapp.com/blog)
 
 ## Development & Testing
 
 All development on BookStack is currently done on the master branch. When it's time for a release the master branch is merged into release with built & minified CSS & JS then tagged at it's version. Here are the current development requirements:
 
-* [Node.js](https://nodejs.org/en/)
-* [Gulp](http://gulpjs.com/)
+* [Node.js](https://nodejs.org/en/) v6.9+
+
+SASS is used to help the CSS development and the JavaScript is run through browserify/babel to allow for writing ES6 code. Both of these are done using gulp. To run the build task you can use the following commands:
 
-SASS is used to help the CSS development and the JavaScript is run through browserify/babel to allow for writing ES6 code. Both of these are done using gulp.
+``` bash
+# Build and minify for production
+npm run-script build
+
+# Build for dev (With sourcemaps) and watch for changes
+npm run-script dev
+```
 
 BookStack has many integration tests that use Laravel's built-in testing capabilities which makes use of PHPUnit. To use you will need PHPUnit installed and accessible via command line. There is a `mysql_testing` database defined within the app config which is what is used by PHPUnit. This database is set with the following database name, user name and password defined as `bookstack-test`. You will have to create that database and credentials before testing.
 
 The testing database will also need migrating and seeding beforehand. This can be done with the following commands:
 
-```
+``` bash
 php artisan migrate --database=mysql_testing
 php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
 ```
 
-Once done you can run `phpunit` (or `./vendor/bin/phpunit` if `phpunit` is not found) in the application root directory to run all tests.
+Once done you can run `phpunit` in the application root directory to run all tests.
+
+## Website and Docs 
+
+The website and project docs are currently stored in the [BookStackApp/website](https://github.com/BookStackApp/website) repo. The docs are stored as markdown files in the `resources/docs` folder
 
 ## License
 
@@ -46,3 +63,12 @@ These are the great projects used to help build BookStack:
 * [ZeroClipboard](http://zeroclipboard.org/)
 * [TinyColorPicker](http://www.dematte.at/tinyColorPicker/index.html)
 * [Marked](https://github.com/chjj/marked)
+* [Moment.js](http://momentjs.com/)
+* [BarryVD](https://github.com/barryvdh)
+    * [Debugbar](https://github.com/barryvdh/laravel-debugbar)
+    * [Dompdf](https://github.com/barryvdh/laravel-dompdf)
+    * [Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy)
+    * [Laravel IDE helper](https://github.com/barryvdh/laravel-ide-helper)
+* [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html)
+
+Additionally, Thank you [BrowserStack](https://www.browserstack.com/) for supporting us and making cross-browser testing easy.