diff --git a/README.md b/README.md
index 8774d83..57139e3 100644
--- a/README.md
+++ b/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,65 +21,30 @@ 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/reactoms@0.4.0/dist/style.min.css`
-
-Add this script at the end of the body of your index.html :
-`https://cdn.jsdelivr.net/npm/reactoms@0.4.0/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 : `` 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 : `` for the icons
+ - inside your index.html again : `` 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*
@@ -91,7 +52,7 @@ Lib Atoms :
- **Link** => *a*
- **List** => *ul -> li*
-Lib Molecules :
+Molecules :
- **Button** => *Link -> Icon + (b)*
- **Footer** => *footer -> List -> Button*
- **Gallery** => *List -> Link -> (Card -> Image + Title + List -> Icon)*
@@ -99,12 +60,6 @@ Lib Molecules :
- **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
diff --git a/index.html b/index.html
deleted file mode 100644
index 88f87bd..0000000
--- a/index.html
+++ /dev/null
@@ -1,17 +0,0 @@
-
-
-
-
-
-
- Reactoms
-
-
-
-
-
-
-
-
-
-
diff --git a/package-lock.json b/package-lock.json
index 8b542a4..0342661 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,14 +1,15 @@
{
"name": "reactoms",
- "version": "0.4.2",
+ "version": "0.4.3",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "reactoms",
- "version": "0.4.2",
+ "version": "0.4.3",
"license": "Apache-2.0",
"dependencies": {
+ "@fortawesome/fontawesome-free": "^6.3.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
@@ -499,6 +500,14 @@
"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
}
},
+ "node_modules/@fortawesome/fontawesome-free": {
+ "version": "6.6.0",
+ "resolved": "https://registry.npmjs.org/@fortawesome/fontawesome-free/-/fontawesome-free-6.6.0.tgz",
+ "integrity": "sha512-60G28ke/sXdtS9KZCpZSHHkCbdsOGEhIUGlwq6yhY74UpTiToIh8np7A8yphhM4BWsvNFtIvLpi4co+h9Mr9Ow==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
"node_modules/@humanwhocodes/config-array": {
"version": "0.11.14",
"resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.14.tgz",
diff --git a/package.json b/package.json
index 839c31d..7a223b1 100644
--- a/package.json
+++ b/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"
},
diff --git a/src/app/App.jsx b/src/app/App.jsx
deleted file mode 100644
index 67df9eb..0000000
--- a/src/app/App.jsx
+++ /dev/null
@@ -1,151 +0,0 @@
-import { Card } from '../../lib/atoms/card/Card'
-import { Collapse } from '../../lib/atoms/collapse/Collapse'
-import { Icon } from '../../lib/atoms/icon/Icon'
-import { Image } from '../../lib/atoms/image/Image'
-import { Link } from '../../lib/atoms/link/Link'
-import { List } from '../../lib/atoms/list/List'
-
-import { Slider } from '../../lib/molecules/slider/Slider'
-import { Title } from '../../lib/molecules/title/Title'
-
-import tsLogo from '../assets/ts.svg'
-import reactLogo from '../assets/react.svg'
-import sassLogo from '../assets/sass.svg'
-import viteLogo from '../assets/vite.svg'
-
-import './app.css'
-
-/**
- * ! APP FUNCTION COMPONENT
- * @name App
- * @description The homepage of the Reactoms library
- *
- * @returns {React.ReactElement}
- * The rendered Article with the lib components
- */
-const App = () => {
-
- return (
-
-
-
-
-
-
- }
- />
-
-
- }
- />
-
-
- }
- />
-
-
- }
- />
-
- }
- caption="Click on the TypeScript, React, Sass & Vite logos to learn more..."
- />
-
- ,
- ,
- ,
- ,
- ,
- ,
- ,
-
- ]}
- />
-
-
- }
- />
-
- )
-}
-
-export default App
diff --git a/src/app/app.css b/src/app/app.css
deleted file mode 100644
index 2710f23..0000000
--- a/src/app/app.css
+++ /dev/null
@@ -1,41 +0,0 @@
-@keyframes logo-spin {
- from { transform: rotate(0deg) }
- to { transform: rotate(360deg) }
-}
-
-#root {
- max-width: 1280px;
- margin: 0 auto;
- padding: 2rem;
- text-align: center;
-}
-
-article {
- display: flex;
- flex-flow: column;
- gap: 1rem;
- place-items: center;
-}
-
-img {
- height: 6em;
- padding: 1.5em;
- will-change: filter;
- transition: filter 300ms;
-
- &:hover {
- filter: drop-shadow(0 0 2em #61dafbaa);
- }
-}
-
-.react {
- animation: logo-spin infinite 20s linear;
-}
-
-.card {
- padding: 1rem;
-}
-
-.read-the-docs {
- color: hsl( 0, 0%, 80%);
-}
diff --git a/src/assets/react.svg b/src/assets/react.svg
deleted file mode 100644
index 6c87de9..0000000
--- a/src/assets/react.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/src/assets/sass.svg b/src/assets/sass.svg
deleted file mode 100644
index 75405d4..0000000
--- a/src/assets/sass.svg
+++ /dev/null
@@ -1,18 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/src/assets/ts.svg b/src/assets/ts.svg
deleted file mode 100644
index a46d53d..0000000
--- a/src/assets/ts.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/src/assets/vite.svg b/src/assets/vite.svg
deleted file mode 100644
index e7b8dfb..0000000
--- a/src/assets/vite.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/src/main.jsx b/src/main.jsx
deleted file mode 100644
index 9a5dacc..0000000
--- a/src/main.jsx
+++ /dev/null
@@ -1,9 +0,0 @@
-import { StrictMode } from 'react'
-import { createRoot } from 'react-dom/client'
-import App from './app/App'
-
-createRoot(document.getElementById('root')).render(
-
-
- ,
-)