Skip to content
Snippets Groups Projects
Verified Commit 98e6ebd7 authored by Volker Schukai's avatar Volker Schukai :alien:
Browse files

chore: update documentation

parent 28a643f9
No related branches found
No related tags found
No related merge requests found
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectRootManager">
<output url="file://$PROJECT_DIR$/out" />
</component>
<component name="accountSettings">
<option name="activeProfile" value="profile:default" />
<option name="activeRegion" value="eu-west-1" />
......
......@@ -24,7 +24,7 @@ For some functions, you need additional [polyfills](#polyfill).
## Documentation
To check out docs and examples, visit [monsterjs.org/en/doc/monster/](https://monsterjs.org/en/doc/monster/).
To check out docs and examples, visit [monsterjs.org/en/doc/monster/](https://monsterjs.org/en/api/).
## Installation
......
......@@ -2,7 +2,19 @@
## Introduction
MonsterJS is a versatile JavaScript library designed to simplify the development of interactive web applications. It offers a range of functionalities, including DOM manipulation, internationalization (i18n), and data processing capabilities.
Monster serves as an excellent option for crafting visually striking and high-efficiency web UIs and websites via
contemporary JavaScript development practices.
Utilizing advanced JavaScript functionalities like classes, WeakRef, WeakMaps, proxies, and the MutationObserver API,
Monster combines proven techniques with pioneering web elements.
Engineered for smooth amalgamation, Monster augments your ongoing web endeavors without overwhelming the overall framework.
In contrast to approaches that add an entirely new level of complexity and exclusive languages, Monster emphasizes on
bolstering the inherent strengths of HTML, CSS, and JavaScript in web development.
Aiming for superior performance and exceptional results, Monster seeks to achieve this with a reduced amount of JavaScript code.
## Installation
......@@ -14,18 +26,19 @@ npm install @schukai/monster
## Usage
Import MonsterJS into your project:
Import Monster into your project:
```javascript
import Monster from '@schukai/monster';
```
Then, you can use MonsterJS's features to enhance your web application.
Then, you can use Monster's features to enhance your web application.
## Documentation
For detailed documentation and examples of how to use MonsterJS, please visit the official MonsterJS documentation.
For detailed documentation and examples of how to use Monster, please visit
the official [MonsterJS documentation](https://monsterjs.org/en/doc/#getting-started).
## License
This project is licensed under the AGPL-3.0 License.
\ No newline at end of file
This project is licensed under the AGPL-3.0 License, professional support is available upon request.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment