litespeed.js/README.md

Lite & fast micro javascript framework that is easy to learn

<p>
    <img height="45" src="images/litespeed-js.png" alt="Logo">
</p>

![npm](https://img.shields.io/npm/dt/litespeed.js.svg)
[![npm version](https://badge.fury.io/js/litespeed.js.svg)](https://badge.fury.io/js/litespeed.js)
[![Build Status](https://travis-ci.org/litespeed-js/litespeed.js.svg?branch=master)](https://travis-ci.org/litespeed-js/litespeed.js)
[![Chat With Us](https://img.shields.io/gitter/room/litespeed-js/community.svg)](https://gitter.im/litespeed-js/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)

Litespeed.js is a micro Javascript framework for building simple web applications. Litespeed.js is dependency-free and **easy to learn** framework which allows you to extend your DOM functionality in a semantic and declarative way.

The litespeed.js framework main features include an **[MVVM](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93viewmodel)** architecture, built-in single page **routing**, easy to build **view components**, **dependency injection** service, **data binding**, and fully **valid and accessible HTML and DOM**.

Litespeed.js makes very good use of both browser memory management, garbage collection and rendering to maximize your web application performance. As of version 0.2.* litespeed.js weights only **4.9kb (minified and compressed)**

## Main Features

- Zero Dependencies
- 4.9kb (minified and compressed)
- No Tooling Required
- Loves and Embrace HTML
- MVVM
- Built-in Router

## Resources

- [Documentation](/docs/get-started.md)
- [Contributing](#contributing)
- [Copyright and license](#copyright-and-license)

## Getting Started

Install with [NPM](https://www.npmjs.com/):

```bash
npm install litespeed.js
```

Install with CDN:
```html
<script src="https://cdn.jsdelivr.net/npm/litespeed.js@v0.3.12"></script>
```

After adding the library to your project, go to our [documentation](/docs/get-started.md) to learn how to use Litespeed.js APIs, services and view components.

You can also check out our demo TODO app which is a good way to understand the framework basic concepts.

## Contributing

All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.

Fork the project, create a feature branch, and send us a pull request.

For security issues, please email security@appwrite.io instead of posting a public issue in GitHub.

## Copyright and license

The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php