Skip to content

Commit

Permalink
readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed Nov 12, 2020
1 parent fc620e3 commit 778e0c8
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,25 @@

Once your tests succeed, use this action to deploy your commit, branch, and tag to [Surge](https://surge.sh).

This allows you to git ignore your outputs (e.g. build files, documentation, etc) such that their changes don't make your repository dirty, nor pollute your git history, while allowing you to leverage CDN to referfence your source code and outputs, for every commit, branch, and tag.
This allows you to git ignore your outputs (e.g. build files, documentation, etc) such that their changes don't make your repository dirty, nor pollute your git history, while allowing you to leverage CDN to reference your source code and outputs, for every commit, branch, and tag.

## Example

For instance, for the [ambi](https://github.com/bevry/ambi) project.

You can get the rendered documentation for:

- the [`master` branch](https://github.com/bevry/ambi/tree/master) via
the [`master` branch](https://github.com/bevry/ambi/tree/master) via

> http://master.ambi.bevry.surge.sh/docs/globals.html
> http://master.ambi.bevry.surge.sh/docs/globals.html
- the [`v8.22.0`](https://github.com/bevry/ambi/releases/tag/v6.6.0) tag via:
the [`v8.22.0` tag](https://github.com/bevry/ambi/releases/tag/v6.6.0) via:

> http://v8.22.0.ambi.bevry.surge.sh/docs/globals.html
> http://v8.22.0.ambi.bevry.surge.sh/docs/globals.html
- the [`0250e1ed2cbc01773e0974165d1c9469c922b271` commit](https://github.com/bevry/ambi/commit/0250e1ed2cbc01773e0974165d1c9469c922b271) via:
> http://0250e1ed2cbc01773e0974165d1c9469c922b271.ambi.bevry.surge.sh/docs/globals.html
the [`0250e1ed2cbc01773e0974165d1c9469c922b271` commit](https://github.com/bevry/ambi/commit/0250e1ed2cbc01773e0974165d1c9469c922b271) via:

> http://0250e1ed2cbc01773e0974165d1c9469c922b271.ambi.bevry.surge.sh/docs/globals.html
## Install

Expand Down

0 comments on commit 778e0c8

Please sign in to comment.