@unlk/keymaster 1.0.4 → 1.0.5

package/CHANGELOG.md

@@ -2,16 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.5] - 2025-04-28
+
+### Added
+- Input fields
+- Radios
+- Checkboxes
+- Progress bars
+
 ## [1.0.4] - 2025-04-25
 
 ### Updated
-Readme Logo
-Changelog function for github build
+- Readme Logo
+- Changelog function for GitHub build
 
 ## [1.0.3] - 2025-04-25
 
 ### Updated
-Bootstrap 5.3.5
+- Bootstrap 5.3.5
 
 ### Added
 - Spinners

package/README.md

@@ -5,19 +5,10 @@
 <br />
 <div align="center">
   <a href="https://www.unlock.com/">
-    <svg width="54" height="88" viewBox="0 0 54 88" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path d="M42.5456 70.7213H53.182L31.9092 42.5022H21.2728L42.5456 70.7213Z" fill="#CBEBF8"/>
-<path d="M42.5456 70.7213H31.9092V88H42.5456V70.7213Z" fill="#CBEBF8"/>
-<path d="M31.9092 70.7213H42.5456L21.2728 42.5022H10.6364L31.9092 70.7213Z" fill="#66CDF3"/>
-<path d="M31.9092 70.7213V88H21.2728V70.7213H31.9092Z" fill="#66CDF3"/>
-<path d="M21.2728 70.7213H31.9092L10.6364 42.5022V21.2728C10.6364 15.4119 15.4119 10.6364 21.2728 10.6364C27.1337 10.6364 31.9092 15.4119 31.9092 21.2728V25.701H42.5456V21.2728C42.5456 9.50765 33.038 0 21.2728 0C9.50765 0 0.0434132 9.50765 0.0434132 21.2294V42.4588L21.2728 70.7213Z" fill="#3A7BBE"/>
-<path d="M21.2728 70.7213V88H16.2802C14.2832 88 12.4164 87.6527 10.6364 87.0015V70.7213H21.2728Z" fill="#3A7BBE"/>
-<path d="M0.0434139 42.5022L21.2728 70.7647H10.6364V87.0449C4.42822 84.744 0 78.7962 0 71.8066V42.4154V42.5022H0.0434139Z" fill="#3E51A2"/>
-</svg>
-
+    <img src="https://www.unlock.com/wp-content/uploads/2025/04/unlock.svg" alt="Unlock Logo">
   </a>
 
-<h3 align="center">Keymaster</h3>
+  <h3 align="center">Keymaster</h3>
 
   <p align="center">
     The base styles for all Unlock Projects based off Bootstrap 5
@@ -48,24 +39,22 @@
 </details>
 
 <!-- ABOUT THE PROJECT -->
-
 ## About The Project
 
-Keymaster is the shared visual and interactive language that guides how we build high-quality customer experience. It’s
-intended for use both internally at Unlock and externally by third-party developers and designers.
+Keymaster is the shared visual and interactive language that guides how we build high-quality customer experience. It’s intended for use both internally at Unlock and externally by third-party developers and designers.
 
 More specifically, we aim to:
-
-* Make it easier for our customers and partners to do business with us by obscuring organizational boundaries, channels
-  and technology stacks.
+* Make it easier for our customers and partners to do business with us by obscuring organizational boundaries, channels and technology stacks.
 * Save time and money during the design and delivery phase.
 * Ease collaboration and align teams.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
+
 ### Built With
 
 [![Bootstrap][Bootstrap.com]][Bootstrap-url]
+
 [![Storybook][Storybook.js.org]][Storybook-url]
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -73,18 +62,15 @@ More specifically, we aim to:
 
 
 <!-- GETTING STARTED -->
-
 ## Getting Started
 
 ### Prerequisites
 
 The design system has a few dependencies that you will need to install before you can use it.
-
 * [Bootstrap 5](https://getbootstrap.com/docs/)
 * [Sass](https://sass-lang.com/) (Optional: If you want to compile the Sass files yourself.)
 
-Symphony also requires you to have [Bootstrap 5](https://getbootstrap.com/docs/) installed in your project as a
-peer-dependency.
+Symphony also requires you to have [Bootstrap 5](https://getbootstrap.com/docs/) installed in your project as a peer-dependency.
 If you do not have Bootstrap 5 installed, you can install it with the following command:
 
 ```sh
@@ -105,8 +91,8 @@ npm install --save-dev sass
 npm install -g sass
 ```
 
-### Installation
 
+### Installation
 To install `@unlk/keymaster` in your project with [npm](https://www.npmjs.com/), run the following command:
 
 ```sh
@@ -118,7 +104,6 @@ npm install @unlk/keymaster
 
 
 <!-- USAGE EXAMPLES -->
-
 ## Usage
 
 To use the keymaster design system, you will need to import the scss file into your project.
@@ -144,14 +129,9 @@ import '@unlk/keymaster/js/bootstrap.js';
 
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
-
 [product-screenshot]: images/screenshot.png
-
 [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
-
 [Bootstrap-url]: https://getbootstrap.com
-
 [Storybook.js.org]: https://img.shields.io/badge/Storybook-ff4785?style=for-the-badge&logo=storybook&logoColor=white
-
 [Storybook-url]: https://storybook.js.org/