Skip to content

Commit

Permalink
add optimized readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JonathanSchndr committed May 12, 2022
1 parent 0bcea4d commit 93f112e
Showing 1 changed file with 82 additions and 2 deletions.
84 changes: 82 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,86 @@
# Nuxt Module
# Vue-fullpage.js - Official Nuxt Module

## Development
<p align="center">
Official Nuxt Module for the <a target="_blank" href="https://github.com/alvarotrigo/fullPage.js/">fullpage.js library</a>.
</p>

<div align="center">

[![npm version][npm-version-src]][npm-version-href]

</div>

- [fullpage.js Extensions](https://alvarotrigo.com/fullPage/extensions/)
- By [@imac2](https://twitter.com/imac2). Thanks to [VasiliyGryaznoy](https://github.com/VasiliyGryaznoy) , [dragg](https://github.com/dragg) and [Raphael Owino](https://twitter.com/ralphowino)

## Table of contents

- [Vue-fullpage.js - Official Nuxt Module](#vue-fullpagejs---official-nuxt-module)
- [Table of contents](#table-of-contents)
- [Installation](#installation)
- [License](#license)
- [Commercial license](#commercial-license)
- [Open source license](#open-source-license)
- [Example](#example)
- [Usage](#usage)
- [Contributing](#contributing)
- [Resources](#resources)

## Installation

1. Add `@fullpage/nuxt-fullpage` dependency to your project

```bash
npm install @fullpage/nuxt-fullpage
```

2. Add `@fullpage/nuxt-fullpage` to the `modules` section of `nuxt.config.js`

```js
// nuxt.config.js
{
modules: [
'@fullpage/nuxt-fullpage'
]
}
```

## License

### Commercial license
If you want to use fullPage to develop nonopen sourced sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. This means, you won't have to change your whole application source code to an open-source license. [[Purchase a Fullpage Commercial License]](https://alvarotrigo.com/fullPage/pricing/)

### Open source license
If you are creating an open-source application under a license compatible with the [GNU GPL license v3](https://www.gnu.org/licenses/gpl-3.0.html), you may use fullPage under the terms of the GPLv3.

**You will have to provide a prominent notice that fullPage.js is in use. The credit comments in the JavaScript and CSS files should be kept intact** (even after combination or minification).

[Read more about fullPage's license](https://alvarotrigo.com/fullPage/pricing/).

## Example

- Run `npm run dev:prepare` to generate type stubs.
- Use `npm run dev` to start [playground](./playground) in development mode.

## Usage

Take a look at the usage of the [official Vue wrapper](https://github.com/alvarotrigo/vue-fullpage.js#usage).

## Contributing

Please see [Contributing to fullpage.js](https://github.com/alvarotrigo/fullPage.js/wiki/Contributing-to-fullpage.js)

## Resources

- [Wordpress theme](https://alvarotrigo.com/fullPage/utils/wordpress.html)
- [fullpage.js Extensions](https://alvarotrigo.com/fullPage/extensions/)
- [WordPress Plugin for Elementor](https://alvarotrigo.com/fullPage/wordpress-plugin-elementor/)
- [WordPress Plugin for Gutenberg](https://alvarotrigo.com/fullPage/wordpress-plugin-gutenberg/)
- [CSS Easing Animation Tool - Matthew Lein](http://matthewlein.com/ceaser/) (useful to define the `easingcss3` value)
- [fullPage.js cdnJS CDN](https://cdnjs.com/libraries/fullPage.js)



<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@fullpage/nuxt-fullpage/latest.svg
[npm-version-href]: https://www.npmjs.com/package/@fullpage/nuxt-fullpage

0 comments on commit 93f112e

Please sign in to comment.