Permalink
Browse files

Updates documentation

  • Loading branch information...
1 parent bd90160 commit b9dfa0f537ac50f7096617584c3e2124d85f982e @kennethormandy kennethormandy committed Oct 29, 2015
Showing with 22 additions and 0 deletions.
  1. +21 −0 README.md
  2. +1 −0 package.json
View
@@ -2,6 +2,27 @@
The Gulp plugin for [Surge](https://surge.sh).
+## Getting started
+
+Publish a static site or client-side application to [Surge](https://surge.sh). First, install the plugin using [npm](https://npmjs.org):
+
+```sh
+npm install --save-dev gulp-surge
+```
+
+Then, require it in your Gulpfile and add it as a task:
+
+```js
+var surge = require('gulp-surge')
+
+gulp.task('deploy', [], function () {
+ return surge({
+ project: './build', // Path to your static build directory
+ domain: 'example.surge.sh' // Your domain or Surge subdomain
+ })
+})
+```
+
## License
[The MIT License (MIT)](LICENSE.md)
View
@@ -5,6 +5,7 @@
"repository": "https://github.com/surge-sh/gulp-surge",
"homepage": "https://surge.sh",
"author": "Kenneth Ormandy <kenneth@surge.sh> (https://surge.sh)",
+ "license": "MIT",
"contributors": [
"Kenneth Ormandy <kenneth@surge.sh> (http://kennethormandy.com)",
"Brock Whitten <brock@surge.sh> (http://sintaxi.com)"

0 comments on commit b9dfa0f

Please sign in to comment.