Documentation

Author: mnapoli

README.md

@@ -1,46 +1,21 @@
-# My Awesome Project
+Development web server for serverless-native PHP web apps.
 
-This is the catchphrase: what does this project do and how is it unique?
-
-[![Build Status](https://img.shields.io/travis/com/PHP-DI/PHP-DI/master.svg?style=flat-square)](https://travis-ci.com/PHP-DI/PHP-DI)
-[![Latest Version](https://img.shields.io/github/release/PHP-DI/PHP-DI.svg?style=flat-square)](https://packagist.org/packages/PHP-DI/php-di)
-[![Total Downloads](https://img.shields.io/packagist/dt/PHP-DI/PHP-DI.svg?style=flat-square)](https://packagist.org/packages/PHP-DI/php-di)
-
-Here is an additional quick introduction, if necessary.
+**This project is currently experimental and the documentation incomplete.**
 
 ## Why?
 
-Why does this project exist? Come on, don't delete this part. Fill it.
-Yes it's hard, but it's perhaps the most important part of the README.
-
-As to why *this* project exist, it's to serve as a template for future open
-source PHP projects. Of course, feel free to fork it and make your own recipe.
+This web server is meant for HTTP applications implemented without framework, using API Gateway as the router and PSR-15 controllers.
 
 ## Installation
 
-Describe how to install the project/library/framework/…
-
-Make sure your installation instructions work by testing them!
+```bash
+composer require --dev bref/dev-server
+```
 
 ## Usage
 
-Describe how to use the project. A gif or a short code example is the best
-way to show how it works. Also keep paragraphs short and sentences simple: not
-everybody speaks english well.
-
-For the sake of the example here is how you can use this project template
-as a basis for your own repository:
+Run the webserver with:
 
 ```bash
-git clone https://github.com/mnapoli/project-template.git my-project
-cd my-project
-# Remove the git repository metadata
-rm -rf .git/
-# Start a brand new repository
-git init
-git add .
+php -S 127.0.0.1:8000 vendor/bin/bref-dev-server
 ```
-
-Easy peasy! Now you just have to code.
-
-Make sure your examples work by testing them! I didn't test mine and I should feel ashamed.

bin/dev-server bin/bref-dev-serverbin/dev-server renamed to bin/bref-dev-server

@@ -5,7 +5,7 @@
     "license": "MIT",
     "type": "library",
     "bin": [
-        "bin/dev-server"
+        "bin/bref-dev-server"
     ],
     "autoload": {
         "psr-4": {