Merge pull request #4 from axentix/develop

1.1.0

CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.1.0 - 2020-09-06
+
+- ADDED
+- REMOVED
+- IMPROVED
+  - Update Axentix to 1.0.0-beta.2
+  - Update dependencies
+- BUGFIXES
+  - `data-neu-hover` change state at startup
+
 # 1.0.1 - 2020-04-23
 
 - ADDED

README.md

@@ -1,39 +1,100 @@
 <p align="center">
-  <a href="https://useaxentix.com/">
-    <img src="https://useaxentix.com/img/axentix-250.png" alt="Axentix Logo" width="120" height="120">
+  <a href="https://neu.useaxentix.com/">
+    <img src="https://neu.useaxentix.com/img/neu-axentix.svg" alt="Neu-Axentix Logo" width="120" height="120">
   </a>
 </p>
 
 <h3 align="center">Neu-Axentix - The first framework based on neumorphism</h3>
 
 <p align="center">
+  <a href="https://neu.useaxentix.com/"><strong>Home</strong></a> |
   <a href="https://neu.useaxentix.com/docs/"><strong>Documentation</strong></a>
 </p>
 
+<br>
+
+<p align="center">
+  <a href="https://badge.fury.io/js/neu-axentix">
+    <img src="https://badge.fury.io/js/neu-axentix.svg" alt="npm version" />
+  </a>
+  <img src="https://img.shields.io/github/v/release/axentix/neumorphic" alt="GitHub release (latest by date)" />
+  <a href="https://www.jsdelivr.com/package/npm/neu-axentix">
+    <img src="https://data.jsdelivr.com/v1/package/npm/neu-axentix/badge?style=rounded" alt="jsDelivr Hits" />
+  </a>
+  <img src="https://img.shields.io/david/axentix/neumorphic" alt="Dependencies" />
+  <img src="https://img.shields.io/david/dev/axentix/neumorphic" alt="Dev Dependencies" />
+  <a href="https://packagephobia.com/result?p=neu-axentix">
+    <img src="https://packagephobia.com/badge?p=neu-axentix" alt="install size" />
+  </a>
+  <a href="https://snyk.io/test/github/axentix/neumorphic?targetFile=package.json">
+    <img src="https://snyk.io/test/github/axentix/neumorphic/badge.svg?targetFile=package.json" alt="Known Vulnerabilities" />
+  </a>
+  <img src="https://img.shields.io/github/license/axentix/neumorphic" alt="License" />
+</p>
+
+<p align="center">
+  <a href="https://discord.gg/8tgRDED">
+    <img src="https://img.shields.io/discord/727545620683816980" alt="Discord" />
+  </a>
+  <a href="https://openbase.io/js/neu-axentix?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge">
+    <img src="https://badges.openbase.io/js/rating/neu-axentix.svg" alt="Rate on Openbase" />
+  </a>
+</p>
+
+Neu-Axentix is the first front end framework based on neumorphism using CSS and JS. Start creating your website using neumorphic design.
+
 ## Quickstart
 
-- You can download the latest release from [Github](https://github.com/axentix/neumorphic/releases/latest).
-- Clone the repo : `git clone https://github.com/axentix/neumorphic.git`
-- Install with [npm](https://www.npmjs.com/) : `npm install neu-axentix`
+### NPM
+```
+npm install neu-axentix
+```
+
+### Yarn
+```
+yarn add neu-axentix
+```
+
+### CDN
+
+Include the files with [jsDelivr](https://www.jsdelivr.com/package/npm/neu-axentix).
+
+### Github Release  
+You can download the latest release from [Github](https://github.com/axentix/neumorphic/releases/latest).
+
+### Clone the repo
+```
+git clone https://github.com/axentix/neumorphic.git
+cd neumorphic
+npm install
+```
+
+After installation you have access to our source files.  
+You can build project with `npm run build` or watch it with `npm run watch`.  
+We use BrowserSync for our development process.
 
 ## Documentation
 
-Found the documentation at <https://neu.useaxentix.com/>.  
+Find the documentation at <https://neu.useaxentix.com/docs/>.
 
 ## Changelog
 
 Changelog is accessible in the [CHANGELOG.md](CHANGELOG.md) file or in [the release section](https://github.com/axentix/neumorphic/releases).
 
 ## Creators
 
-- Axel SIMONET  
+- Axel SIMONET - (Xelzs)  
+  [Github](https://github.com/Xelzs)  
   [Linkedin](https://www.linkedin.com/in/axel-simonet/)  
   [Website](https://axelsimonet.fr/)
-- Vincent LEVEQUE  
+- Vincent LEVEQUE - (Stallos11)  
+  [Github](https://github.com/Stallos11)  
   [Linkedin](https://www.linkedin.com/in/leveque-vincent/)
 
-#
+<br>
+
+___
 
 <p align="center">
-Neu-Axentix Framework - Made with ♥ by Axel SIMONET & Vincent LEVEQUE
+Neu-Axentix Framework - Made with ❤️ by Axel SIMONET & Vincent LEVEQUE
 </p>

examples/tables.html

@@ -2,68 +2,76 @@
   <head>
     <title>Axentix Layout - Fixed sidenav</title>
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <link
-      rel="stylesheet"
-      href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/all.min.css"
-    />
-    <link rel="stylesheet" href="../dist/css/axentix.min.css" />
+    <link rel="stylesheet" href="../node_modules/axentix/dist/css/axentix.min.css" />
+    <link rel="stylesheet" href="../dist/css/neu-axentix.min.css" />
   </head>
 
-  <body>
+  <body class="neu-light">
     <header></header>
 
     <main>
-      <table class="table bordered">
-        <thead>
-          <tr>
-            <th>#</th>
-            <th>Name</th>
-            <th>Age</th>
-            <th>City</th>
-          </tr>
-        </thead>
-        <tbody>
-          <tr>
-            <td>1</td>
-            <td>Paul</td>
-            <td>24</td>
-            <td>
-              <a href="" class="btn outline txt-red"><span class="outline-text">Yes</span></a>
-              <a href="" class="btn outline opening txt-red"><span class="outline-text">No</span></a>
-              <a href="" class="btn outline opening txt-red rounded-4"
-                ><span class="outline-text">No</span></a
-              >
-              <a href="" class="btn press red">test</a>
-            </td>
-          </tr>
-          <tr>
-            <td>2</td>
-            <td>Patrick</td>
-            <td>34</td>
-            <td>
-              <button class="btn outline txt-red"><span class="outline-text">Yes</span></button>
-              <button class="btn outline opening txt-red"><span class="outline-text">No</span></button>
-              <button class="btn outline opening txt-red rounded-4">
-                <span class="outline-text">No</span>
-              </button>
-              <button class="btn press red">test</button>
-            </td>
-          </tr>
-          <tr>
-            <td>3</td>
-            <td>Robert</td>
-            <td>62</td>
-            <td>
-              <div class="btn outline txt-red"><span class="outline-text">Yes</span></div>
-              <div class="btn outline opening txt-red"><span class="outline-text">No</span></div>
-              <div class="btn outline opening txt-red rounded-4"><span class="outline-text">No</span></div>
-              <div class="btn press red">test</div>
-            </td>
-          </tr>
-        </tbody>
-      </table>
+      <div class="container">
+        <div class="card neu-flat">
+          <div class="responsive-table">
+            <table class="table">
+              <thead>
+                <tr>
+                  <th>#</th>
+                  <th>Name</th>
+                  <th>Age</th>
+                  <th>City</th>
+                </tr>
+              </thead>
+              <tbody>
+                <tr data-neu-hover="neu-pressed">
+                  <td>1</td>
+                  <td>Paul</td>
+                  <td>24</td>
+                  <td>
+                    <a href="" class="btn outline txt-red"><span class="outline-text">Yes</span></a>
+                    <a href="" class="btn outline opening txt-red"><span class="outline-text">No</span></a>
+                    <a href="" class="btn outline opening txt-red rounded-4"
+                      ><span class="outline-text">No</span></a
+                    >
+                    <a href="" class="btn press red">test</a>
+                  </td>
+                </tr>
+                <tr data-neu-hover="neu-pressed">
+                  <td>2</td>
+                  <td>Patrick</td>
+                  <td>34</td>
+                  <td>
+                    <button class="btn outline txt-red"><span class="outline-text">Yes</span></button>
+                    <button class="btn outline opening txt-red"><span class="outline-text">No</span></button>
+                    <button class="btn outline opening txt-red rounded-4">
+                      <span class="outline-text">No</span>
+                    </button>
+                    <button class="btn press red">test</button>
+                  </td>
+                </tr>
+                <tr data-neu-hover="neu-pressed">
+                  <td>3</td>
+                  <td>Robert</td>
+                  <td>62</td>
+                  <td>
+                    <div class="btn outline txt-red"><span class="outline-text">Yes</span></div>
+                    <div class="btn outline opening txt-red"><span class="outline-text">No</span></div>
+                    <div class="btn outline opening txt-red rounded-4">
+                      <span class="outline-text">No</span>
+                    </div>
+                    <div class="btn press red">test</div>
+                  </td>
+                </tr>
+              </tbody>
+            </table>
+          </div>
+        </div>
+      </div>
     </main>
 
     <footer></footer>
+
+    <script src="../node_modules/axentix/dist/js/axentix.min.js"></script>
+    <script src="../dist/js/neu-axentix.min.js"></script>
   </body>
 </html>