at-ui/README.md

A UI Component Library with Vue.js

<p align="center">
  <a href="https://at.aotu.io/">
    <img width="200" src="http://storage.360buyimg.com/mtd/home/logo-at1502718221686.svg">
  </a>
</p>

# AT UI

[![NPM][npm-version-image]][npm-version-url] [![david-dm][david-dm-image]][david-dm-url] [![travis][travis-image]][travis-url]

AT-UI is a modular front-end UI framework for developing fast and powerful web interfaces based on Vue.js.

[中文 README](README.zh-CN.md)

## Features

- Based on `Vue`
- A npm + webpack + babel front-end development workflow
- Support ES2015
- CSS Style independent, make consistent user interfaces (See: [AT-UI-Style](https://github.com/at-ui/at-ui-style))
- Friendly API

## Environment Support

- Modern browsers and Internet Explorer 9+
- [Electron](http://electron.atom.io/)
- [NW.js](http://nwjs.io)

## Links

- [Home Page](https://at-ui.github.io/at-ui/)
- [Vue](https://vuejs.org/)
- [Webpack](https://webpack.js.org/)
- [AT-UI for Angular](https://github.com/icepoint0/at-angular) (Developed by [@icepoint0](https://github.com/icepoint0), Thanks for contribution)

## Install

- Recommended use `npm`

```bash
npm install at-ui
```

- Or using `<script>` tag for global use

```html
<script type="text/javascript" src="at.min.js"></script>
```

## Usage

Because the style of `AT-UI` is independent. It's a separate project. So we should install `AT-UI-Style` in need before we use `AT-UI`. Use npm or script tag according to your preference.

```bash
npm install at-ui-style
```

or

```html
<link rel="stylesheet" href="at.min.css" />
```

## Contribution

Finding bugs, sending pull requests or improving our docs - any contribution is welcome and highly appreciated. To get started, head over to our [contribution guidelines](https://github.com/at-ui/at-ui/blob/master/.github/CONTRIBUTING.md). Thanks!

## License

MIT


[npm-version-image]: https://img.shields.io/npm/v/at-ui.svg?style=flat-square
[npm-version-url]: https://www.npmjs.com/package/at-ui
[david-dm-image]: https://david-dm.org/AT-UI/at-ui.svg?style=flat-square
[david-dm-url]: https://david-dm.org/AT-UI/at-ui
[travis-image]: https://img.shields.io/travis/AT-UI/at-ui/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/AT-UI/at-ui