|
| 1 | +## MIGRATION NOTICE - 28-08-2018 |
| 2 | + |
| 3 | +### **zUIx.js** has got a new home! :smile: |
| 4 | + |
| 5 | +https://github.com/zuixjs/ |
| 6 | + |
| 7 | +--- |
| 8 | +This repository is here only to preserve correct functioning of old sites that might be still referencing and using old version of this library. |
| 9 | + |
| 10 | +--- |
| 11 | + |
1 | 12 | <p align="center">
|
2 | 13 | <a href="https://zuixjs.github.io/zuix" target="_blank" rel="noopener noreferrer">
|
3 | 14 | <img width="96" src="https://zuixjs.github.io/zuix/images/zuix-logo.svg" alt="zUIx logo">
|
4 | 15 | </a>
|
5 | 16 | </p>
|
6 | 17 |
|
7 |
| -<p align="center"> |
8 |
| - <a href="https://travis-ci.org/zuixjs/zuix"><img src="https://travis-ci.org/zuixjs/zuix.svg?branch=master" alt="Build Status"></a> |
9 |
| - <a href="https://badge.fury.io/js/zuix-dist"><img src="https://badge.fury.io/js/zuix-dist.svg" alt="npm dist"></a> |
10 |
| -</p> |
11 |
| - |
12 |
| -# [zUIx](https://zuixjs.github.io/zuix) |
| 18 | +## [zUIx](https://zuixjs.github.io/zuix) |
13 | 19 |
|
14 | 20 | A lightweight JavaScript library to support you in creating amazing component-based websites and web applications.
|
15 |
| -- [Website and Documentation](https://zuixjs.github.io/zuix) |
16 |
| - |
17 |
| -## Examples |
18 |
| - |
19 |
| -- [**WebFlix**](https://github.com/zuixjs/zuix-web-flix) |
20 |
| -*Web app template inspired to Netflix mobile app (PWA)* |
21 |
| -- [**HTML-PWA**](https://github.com/zuixjs/zuix-html-pwa) |
22 |
| -*Web app template of a modern mobile app, made with just HTML, CSS, JavaScript (PWA)* |
23 |
| -- [**Web Book**](https://github.com/zuixjs/zuix-web-book/) |
24 |
| -*Web app template of a web book, suitable for reading but not only (PWA)* |
25 |
| -- [**z-Kit**](https://zuixjs.github.io/zkit) |
26 |
| -*reusable components for modern web* |
27 |
| -- [**TodoMVC**](https://zuixjs.github.io/zuix-todomvc) |
28 |
| -*the classic To-Do MVC application* |
29 |
| -- [**Hacker News Reader**](https://zuixjs.github.io/zuix-hackernews) |
30 |
| -*example web app using* **list_view** *component with progressive/lazy loading* |
31 |
| - |
32 |
| -### Online Playgrounds |
33 |
| - |
34 |
| -- [**zUIx on Glitch**](https://glitch.com/@genemars) |
35 |
| -*examples and tutorials on Glitch* |
36 |
| -- [**zUIx on CodePen**](https://codepen.io/genielabs/) |
37 |
| -*examples and tutorials on CodePen* |
38 |
| - |
39 |
| - |
40 |
| -## Getting Started |
41 |
| - |
42 |
| -Start using **zUIx** with the [zUIx Web Starter](https://github.com/zuixjs/zuix-web-starter) project, |
43 |
| -or start from scratch by including it in your project using one of the methods described below. |
44 |
| - |
45 |
| -### Local copy |
46 |
| - |
47 |
| -Download and copy the `.js` file to your project folder and include it in your HTML page: |
48 |
| - |
49 |
| -```html |
50 |
| -<script src="js/zuix.min.js"></script> |
51 |
| -``` |
52 |
| - |
53 |
| -[Download **zUIx v0.4.9-56**](https://zuixjs.github.io/zuix/js/zuix.min.js) |
54 |
| -*~13 kB (gzipped)* |
55 |
| - |
56 |
| -### Hosted |
57 |
| - |
58 |
| -Link the `.js` file as an external resource from *GitHub* site: |
59 |
| - |
60 |
| -```html |
61 |
| -<script src="https://zuixjs.github.io/zuix/js/zuix.min.js"></script> |
62 |
| -``` |
63 |
| - |
64 |
| -### NPM |
65 |
| - |
66 |
| -Install from *NPM* |
67 |
| - |
68 |
| - npm install zuix-dist --save |
69 |
| - |
70 |
| -Copy the library from `node_modules/zuix-dist/js` to your project folder |
71 |
| -and include it in your HTML pages: |
72 |
| - |
73 |
| -```html |
74 |
| - <script src="js/zuix.min.js"></script> |
75 |
| -``` |
76 |
| - |
77 |
| -### Bower |
78 |
| - |
79 |
| -Install from *Bower* |
80 |
| - |
81 |
| - bower install zuix-dist --save |
82 |
| - |
83 |
| -Copy the library from `bower_components/zuix-dist/js` to your project folder |
84 |
| -and include it in your HTML pages: |
85 |
| - |
86 |
| -```html |
87 |
| - <script src="js/zuix.min.js"></script> |
88 |
| -``` |
89 |
| - |
90 |
| -## TypeScript integration |
91 |
| - |
92 |
| -To use zUIx in a TypeScript project you can download and include the auto-generated |
93 |
| -[module definition file](https://raw.githubusercontent.com/zuixjs/zuix/master/dist/ts/zuix.d.ts) |
94 |
| -which is located in the distribution folder of the master repo. |
95 |
| - |
96 |
| - |
97 |
| -## Contributing |
98 | 21 |
|
99 |
| -See the [CONTRIBUTING.md](https://github.com/zuixjs/zuix/blob/master/CONTRIBUTING.md) document. |
| 22 | +[Website and Documentation](https://zuixjs.github.io/zuix) |
0 commit comments