bitinflow/expose
1
0
Fork 0
mirror of https://github.com/bitinflow/expose.git synced 2026-03-13 13:35:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Sebastian Schlein
2021-06-11 16:09:40 +02:00
parent 6b9fee9326
commit c06bcb7119
7 changed files with 37 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/getting-started/installation.md
View File

@@ -4,20 +4,19 @@ order: 1
---
# Installation
Expose can be installed using composer.
The easiest way to install expose is by making it a global composer dependency:
Expose is a PHP package and you can install the client for your local machine as a global composer dependency:
```bash
composer global require beyondcode/expose
```
Now you're ready to go and can [share your first site](/docs/expose/getting-started/sharing-your-first-site).
After that, you are ready to go and can [share your first site](/docs/expose/getting-started/sharing-your-first-site).
### Extending Expose
By default, expose comes as an executable PHAR file. This allows you to use all of the expose features, like sharing your local sites, out of the box - without any additional setup required.
By default, Expose comes as an executable PHAR file. This allows you to use all Expose features out of the box – without any additional setup required.
If you want to modify expose, for example by adding custom request/response modifiers, you will need to clone the GitHub repository instead.
If you want to modify Expose and want to add custom request/response modifiers, you need to clone the GitHub repository instead of the global composer dependency.
You can learn more about how to customize expose in the [extending Expose](/docs/expose/extending-the-server/subdomain-generator) documentation section.
You can learn more about the customization of Expose in the [extending Expose](/docs/expose/extending-the-server/subdomain-generator) documentation section.