@layerfi/components 0.1.17 → 0.1.19

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Layer Financial
+
+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.

package/README.md

@@ -1,19 +1,29 @@
 # Layer Financial React Components
 
-This is a Javascript library that provides easy access to Layer Financial's
-acounting offering through React components.
+Layer's embeddable React component library provides an out of the box accounting experience. This project emphasizes composability and brandability, allowing you to
+
+1. Use full page layouts we've already tested and used _or_ layout individual components however you choose.
+2. Brand components with your company colors, fonts, and more.
+
+All you need to get started is sandbox development credentials - reach out [here](https://www.layerfi.com/#contact-sale) if you don't have those yet!
+
+#### Related links
+
+- Layer home: https://www.layerfi.com
+- Documentation: https://docs.layerfi.com/introduction
+- NPM: https://www.npmjs.com/package/@layerfi/components
 
 <br />
 
 ## Installation
 
-```
+```ts
 npm install --save @layerfi/components
 ```
 
 or
 
-```
+```ts
 yarn install @layerfi/components
 ```
 
@@ -185,7 +195,7 @@ body .Layer__component {
 }
 ```
 
-The full list of variables is listed in the `variables.css file` and contains:
+The full list of variables is listed in the [`variables.css`](https://github.com/Layer-Fi/layer-react/blob/main/src/styles/variables.scss) file and contains:
 
 ```scss
 // 1. BASE VARIABLES: