neu-axentix/README.md

The official Axentix neumorphism design implementation. Start using neumorphism shadows in 3 easy steps.

<p align="center">
  <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 - Neumorphism extension of Axentix</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://www.npmjs.com/package/neu-axentix">
    <img alt="npm" src="https://img.shields.io/npm/v/neu-axentix">
  </a>
  <a href="https://github.com/axentix/neumorphic/releases">
    <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/axentix/neumorphic">
  </a>
  <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 alt="npm bundle size (version)" src="https://img.shields.io/bundlephobia/minzip/neu-axentix">
  <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 framework you need to easily use neumorphism shadows.
Start creating your website using neumorphic design.

## Quickstart

### 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 ci
```

After installation you have access to our source files.  
You can build project with `npm run build` or serve it with `npm run dev`.

## Documentation

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).

## Sponsors

Support this project on [BuyMeACoffee](https://www.buymeacoffee.com/axentix) to become a sponsor and get **your logo here and on the docs** with a link to your website.

<div align="center">
  <a href="https://www.buymeacoffee.com/axentix" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Become a sponsor" height="50" width="180"></a>
</div>

## Backers

Support this project on [BuyMeACoffee](https://www.buymeacoffee.com/axentix) to become a backer and get **your github profile here**.

[<img src="https://avatars.githubusercontent.com/u/32241342?v=4" width="40" style="border-radius:50%"/>](https://github.com/Xelzs)
[<img src="https://avatars.githubusercontent.com/u/49057921?v=4" width="40" style="border-radius:50%"/>](https://github.com/Stallos11)

## Creators

- Axel SIMONET - (Xelzs)  
  [Github](https://github.com/Xelzs)  
  [Linkedin](https://www.linkedin.com/in/axel-simonet/)  
  [Website](https://axelsimonet.fr/)
- 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
</p>