Merge pull request #11 from philippebeck/dev

Release 0.4.3

README.md

@@ -13,10 +13,6 @@ A React Components Library made with TypeScript, Sass, Vite & Atomic Design : Ca
 
 - [Welcome to Reactoms !](#welcome-to-reactoms-)
   - [Installation](#installation)
-  - [NPM](#npm)
-  - [CDN](#cdn)
-  - [GitHub](#github)
-  - [Try](#try)
   - [Usage](#usage)
   - [Content](#content)
   - [Documentation](#documentation)
@@ -25,86 +21,45 @@ A React Components Library made with TypeScript, Sass, Vite & Atomic Design : Ca
 
 ## Installation
 
-Choose one of the following methods :  
-- **NPM** => *Node Package Manager*  
-- **CDN** => *Content Delivery Network*  
-- **GitHub** => *Clone the repository or download the latest release*  
-
----
-
-## NPM
-
 Type this command inside your terminal at the root of your project :  
 `npm i reactoms`  
 
 ---
 
-## CDN
-
-Add this stylesheet to the head of your index.html :  
-`https://cdn.jsdelivr.net/npm/[email protected]/dist/style.min.css`  
-
-Add this script at the end of the body of your index.html :  
-`https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.min.js`  
-
----
-
-## GitHub
-
-`git clone https://github.com/philippebeck/reactoms.git`  
-or  
-[Latest Release](https://github.com/philippebeck/reactoms/releases)  
-
----
-
-## Try
-
-Run the Welcome UI to try the components :  
-`npm start`  
-
----
-
 ## Usage
 
-Process usage after NPM installation :  
-
 1. If you change the components code, you need to compile them :  
 `npm run build`  
 
-2. Then use the compiles files of the dist folder for your prod UI like this :  
-  - inside your pages : `import { Card, Collapse, Icon, Image, Link, List, Title } from 'reactoms'` for the components
-  - inside your index.html : `<style rel="stylesheet" href="node_modules/reactoms/dist/style.css"></style>` for the style
+1. Then use the compiles files of the dist folder for your prod UI like this (*choose the components you want*) :  
+  - inside your pages : `import { Button, Card, Collapse, Footer, Gallery, Icon, Image, Link, List, Navbar, Slider, Title } from 'reactoms'` for the components  
+-  inside your index.html : `<style rel="stylesheet" href="node_modules/@fortawesome/fontawesome-free/css/all.min.css"></style>` for the icons  
+  - inside your index.html again : `<style rel="stylesheet" href="node_modules/reactoms/dist/style.css"></style>` for the style  
 
 ---
 ## Content
 
-Lib Assets :  
+Assets :  
 - **Style** => *imports variables & mixins + common styles*  
 - **Style Variables** => *breakpoints, fonts, colors, transforms*  
 - **Style Mixins** => *font-face & keyframes*  
 
-Lib Atoms :  
+Atoms :  
 - **Card** => *figure -> (figcaption)*  
 - **Collapse** => *details -> summary + figure*  
 - **Icon** => *i*  
 - **Image** => *img*  
 - **Link** => *a*  
 - **List** => *ul -> li*  
 
-Lib Molecules :  
+Molecules :  
 - **Button** => *Link -> Icon + (b)*  
 - **Footer** => *footer -> List -> Button*  
 - **Gallery** => *List -> Link -> (Card -> Image + Title + List -> Icon)*
 - **Navbar** => *nav -> List -> Button*  
 - **Slider** => *figure -> (nav -> Icon) + progress*  
 - **Title** => *hgroup -> (p -> Icon) + h1 | h2 | h3 | h4 + (p)*  
 
-Src Assets :  
-- **Logos** => *ts, react, sass, vite*
-
-Src App :  
-- **App** => *Homepage to test the library*
-
 ---
 
 ## Documentation

package.json

@@ -1,6 +1,6 @@
 {
   "name": "reactoms",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "A React Components Library made with TypeScript, Sass, Vite & Atomic Design : Card, Collapse, Icon, Image, Link, List for Atoms & Button, Footer, Gallery, Navbar, Slider, Title for Molecules",
   "type": "module",
   "keywords":[
@@ -39,12 +39,12 @@
     "./dist/style.css": "./dist/style.css"
   },
   "scripts": {
-    "start": "vite",
     "build": "tsc && vite build",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview"
   },
   "dependencies": {
+    "@fortawesome/fontawesome-free": "^6.3.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },