docs: update readme and contributing guide

erezrokah · erezrokah · commit 9d8e2cce43a2 · 2020-07-08T15:18:06.000+03:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,42 @@
+# CONTRIBUTING
+
+Contributions are always welcome, no matter how large or small. Before contributing,
+please read the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Setup
+
+> Install yarn on your system: https://yarnpkg.com/en/docs/install
+
+```sh
+$ git clone https://github.com/netlify/netlify-identity-widget
+$ cd netlify-identity-widget
+$ yarn
+```
+
+## Building
+
+```sh
+$ yarn build
+```
+
+
+## Running the server
+
+```sh
+$ yarn dev
+```
+
+## Pull Requests
+
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+
+## License
+
+By contributing to Netlify Identity Widget, you agree that your contributions will be licensed
+under its [MIT license](LICENSE).
diff --git a/README.md b/README.md
@@ -4,36 +4,24 @@ A Netlify CMS widget to select directory parent for an entry
 
 ## Usage
 
-## Development
-
-```bash
-yarn
-yarn develop
-```
-
-## Build
-
-```bash
-yarn
-yarn build
-```
-
-## Release
-
-Make sure you have npm + git credentials set up.
-
-- [ ] Make changes and/or merge PRs.
-- [ ] `git checkout master`
-- [ ] `git pull`
-- [ ] `yarn`
-- [ ] Set up semantic release environment variables:
-
-```bash
-export GIT_AUTHOR_NAME=<your-github-login>
-export GIT_AUTHOR_EMAIL=<your-github-email>
-export GIT_COMMITTER_NAME=<your-github-login>
-export GIT_COMMITTER_EMAIL=<your-github-email>
-export GITHUB_TOKEN=<github-token-with-public_repo-permissions>
+Example for using in an HTML file
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Content Manager</title>
+  </head>
+  <body>
+    <script src="https://identity.netlify.com/v1/netlify-identity-widget.js"></script>
+    <script src="https://unpkg.com/netlify-cms@^2.0.0/dist/netlify-cms.js"></script>
+    <script src="https://unpkg.com/@netlify/netlify-cms-widget-parent@^1.0.0/dist/netlify-cms-widget-parent.js"></script>
+    <script>
+      const parentWidget = window.NetlifyCmsWidgetParent;
+      CMS.registerWidget('parent', parentWidget.control, parentWidget.preview);
+    </script>
+  </body>
+</html>
 ```
-
-- [ ] `npm run release`
diff --git a/package.json b/package.json
@@ -12,6 +12,9 @@
     "semantic-release": "cross-env CI=true HUSKY_SKIP_HOOKS=1 semantic-release",
     "release": "run-s build semantic-release publish"
   },
+  "files": [
+    "dist/"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/netlify-labs/netlify-cms-widget-parent.git"
