From 018d778e5fda7b20d67a1db1689d1c3b9f570afb Mon Sep 17 00:00:00 2001
From: Marcel Pociot <m.pociot@gmail.com>
Date: Wed, 22 Apr 2020 13:21:40 +0200
Subject: [PATCH] wip

---
 README.md | 54 ++++++++++++++++++++++++++++--------------------------
 1 file changed, 28 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index 1755288..64db8ed 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,39 @@
-<p align="center">
-    <img title="Laravel Zero" height="100" src="https://raw.githubusercontent.com/laravel-zero/docs/master/images/logo/laravel-zero-readme.png" />
-</p>
+# Expose
 
-<p align="center">
-  <a href="https://github.com/laravel-zero/framework/actions"><img src="https://img.shields.io/github/workflow/status/laravel-zero/framework/Continuous%20Integration.svg" alt="Build Status"></img></a>
-  <a href="https://scrutinizer-ci.com/g/laravel-zero/framework"><img src="https://img.shields.io/scrutinizer/g/laravel-zero/framework.svg" alt="Quality Score"></img></a>
-  <a href="https://packagist.org/packages/laravel-zero/framework"><img src="https://poser.pugx.org/laravel-zero/framework/d/total.svg" alt="Total Downloads"></a>
-  <a href="https://packagist.org/packages/laravel-zero/framework"><img src="https://poser.pugx.org/laravel-zero/framework/v/stable.svg" alt="Latest Stable Version"></a>
-  <a href="https://packagist.org/packages/laravel-zero/framework"><img src="https://poser.pugx.org/laravel-zero/framework/license.svg" alt="License"></a>
-</p>
+## Usage
 
-<h4> <center>This is a <bold>community project</bold> and not an official Laravel one </center></h4>
+## Server
 
-Laravel Zero was created by, and is maintained by [Nuno Maduro](https://github.com/nunomaduro), and is a micro-framework that provides an elegant starting point for your console application. It is an **unofficial** and customized version of Laravel optimized for building command-line applications.
+To start the server, call:
 
-- Built on top of the [Laravel](https://laravel.com) components.
-- Optional installation of Laravel [Eloquent](https://laravel-zero.com/docs/database/), Laravel [Logging](https://laravel-zero.com/docs/logging/) and many others.
-- Supports interactive [menus](https://laravel-zero.com/docs/build-interactive-menus/) and [desktop notifications](https://laravel-zero.com/docs/send-desktop-notifications/) on Linux, Windows & MacOS.
-- Ships with a [Scheduler](https://laravel-zero.com/docs/task-scheduling/) and  a [Standalone Compiler](https://laravel-zero.com/docs/build-a-standalone-application/).
-- Integration with [Collision](https://github.com/nunomaduro/collision) - Beautiful error reporting
+```
+php expose serve
+```
 
-------
+## Client
 
-## Documentation
+To share local connections with a server, call:
 
-For full documentation, visit [laravel-zero.com](https://laravel-zero.com/).
+```
+php expose share somelocalsite.test
+```
 
-## Support the development
-**Do you like this project? Support it by donating**
+### Custom subdomain(s) 
+You can also define a custom subdomain using the `--subdomain` option:
 
-- PayPal: [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=66BYDWAT92N6L)
-- Patreon: [Donate](https://www.patreon.com/nunomaduro)
+```
+php expose share somelocalsite.test --subdomain=custom
+```
 
-## License
+The subdomain option also allows you to specify multiple, comma-separated subdomains:
 
-Laravel Zero is an open-source software licensed under the [MIT license](https://github.com/laravel-zero/laravel-zero/blob/stable/LICENSE.md).
+```
+php expose share somelocalsite.test --subdomain=app,admin
+```
+
+### Basic authentication 
+You can protect your shared URLs using basic authentication, by providing the username and password in the `--auth` option:
+
+```
+php expose share somelocalsite.test --auth="username:password"
+```