@keurig-web/one-header 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2021
+
+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
+(including the next paragraph) 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.

package/README.md

@@ -0,0 +1,36 @@
+# @keurig-web/one-header
+
+One Header react component
+
+## Features
+
+- ES6 syntax, managed with Prettier + Eslint and Stylelint
+- Unit testing via Jest
+
+## Install
+
+```sh
+yarn add @keurig-web/one-header
+// or 
+npm i @keurig-web/one-header
+```
+
+### Requirements
+
+- Node.js `v14.x` or later
+- React ^17
+
+### Usage
+
+```js
+import { OneHeader } from '@keurig-web/one-header';
+import { App } from './app';
+import * as ReactDOM from 'react-dom';
+
+ReactDOM.render(
+  <App>
+    <OneHeader baseUrl={window.location.host} brand={'YOUR_BRAND'} />
+  </App>,
+  document.getElementById('root')
+);
+```