Add license + basic doc

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 GitHub, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,7 +1,10 @@
-# configure-pages
+# Configure-Pages
 
-An action to enable Pages and extract metadata.
+An action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as [starter workflows][starter-workflows].
 
+# Usage
+
+See [action.yml](action.yml)
 
 # Release instructions
 
@@ -19,3 +22,10 @@ In order to release a new version of this Action:
 3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow](release.yml))
 
    ⚠️ Environment approval is required.
+
+# License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE).
+
+<!-- references -->
+[starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages

action.yml

@@ -1,14 +1,14 @@
-name: 'Get the Pages base URL'
+name: "Configure Pages"
-description: 'Get the base URL where the GitHub Pages site will be hosted'
+description: "An action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as starter workflows."
 runs:
-  using: 'node16'
+  using: "node16"
-  main: 'dist/index.js'
+  main: "dist/index.js"
 inputs:
   static_site_generator:
-    description: 'static site generator types. We currently support nuxt, next and gatsby'
+    description: "Optional static site generator to attempt to configure (nuxt, next or gatsby)"
     required: false
   token:
-    description: 'GitHub token'
+    description: "GitHub token"
     default: ${{ github.token }}
     required: true
 outputs: