update reamde and docs

This commit is contained in:
Bobby DeSimone 2019-01-04 21:24:07 -08:00
parent d4818fd5e3
commit 46ac3293a8
No known key found for this signature in database
GPG key ID: AEE4CF12FE86D07E
4 changed files with 52 additions and 3 deletions

5
.firebaserc Normal file
View file

@ -0,0 +1,5 @@
{
"projects": {
"default": "pomerium-21f57"
}
}

View file

@ -6,7 +6,7 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/pomerium/pomerium)](https://goreportcard.com/report/github.com/pomerium/pomerium)
[![LICENSE](https://img.shields.io/github/license/pomerium/pomerium.svg)](https://github.com/pomerium/pomerium/blob/master/LICENSE)
Pomerium is a tool for managing secure access to internal applications and resources
Pomerium is a tool for managing secure access to internal applications and resources.
Use Pomerium to:
@ -15,12 +15,12 @@ Use Pomerium to:
- deploy mutual authenticated encryption (mTLS).
- aggregate logging and telemetry data.
To learn more about zero-trust / BeyondCorp, check out [awesome-zero-trust].
## Get started
For instructions on getting started using Pomerium, see our [docs].
To learn more about zero-trust and BeyondCorp, check out [awesome-zero-trust].
## Start developing
Assuming you have a working [Go environment].

BIN
docs/guide/get-started.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 MiB

44
firebase.json Normal file
View file

@ -0,0 +1,44 @@
{
"hosting": {
"headers": [
{
"source": "**/*.@(eot|otf|ttf|ttc|woff|font.css)",
"headers": [
{
"key": "Access-Control-Allow-Origin",
"value": "*"
}
]
},
{
"source": "**/*.@(js|css)",
"headers": [
{
"key": "Cache-Control",
"value": "max-age=604800"
}
]
},
{
"source": "**/*.@(jpg|jpeg|gif|png|ttf|svg)",
"headers": [
{
"key": "Cache-Control",
"value": "max-age=604800"
}
]
},
{
"source": "404.html",
"headers": [
{
"key": "Cache-Control",
"value": "max-age=300"
}
]
}
],
"public": "docs/.vuepress/dist",
"ignore": ["firebase.json", "**/.*", "**/node_modules/**"]
}
}