Skip to content
This repository was archived by the owner on Oct 16, 2024. It is now read-only.

Commit 269c2ac

Browse files
committed
added basic vue readme
1 parent dec4804 commit 269c2ac

9 files changed

+76
-7
lines changed

packages/react/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@ which functions as the brain of AgileTs and is indispensable.
7171
Unfortunately, we can't combine each `core` with `react` version.
7272
Therefore, we have created a table that shows which versions fit together without restrictions.
7373

74-
| @agile-ts/react | @agile-ts/core | NPM Version | Supported React versions | Supports hook based components |
75-
| --------------- | ----------------------- | ------------------------ | -------------------------|---------------------------------- |
76-
| v0.0.7+ | v0.0.7+ | v6+ | 16.8+ | Yes |
77-
| v0.0.6 | v0.0.3 - v0.0.6 | v6+ | 16.8+ | Yes |
74+
| @agile-ts/react | @agile-ts/core | NPM Version | Supported React versions | Supports hook based components |
75+
| ---------------- | ----------------------- | ------------------------ | -------------------------|---------------------------------- |
76+
| v0.0.15+ | v0.0.16+ | v6+ | 16.8+ | Yes |
77+
| v0.0.7 - v0.0.14 | v0.0.7 - v0.0.15 | v6+ | 16.8+ | Yes |
7878

7979
_Older Versions aren't supported anymore_
8080

@@ -86,7 +86,7 @@ _Older Versions aren't supported anymore_
8686
<img src="https://raw.githubusercontent.com/agile-ts/agile/master/packages/react/static/documentation_header.png" alt="Documentation"/>
8787

8888
Sounds AgileTs interesting to you?
89-
Checkout our **[documentation](https://agile-ts.org/docs/introduction)**, to learn more.
89+
Checkout our **[documentation](https://agile-ts.org/docs/react)**, to learn more.
9090
And I promise you, you will be able to use AgileTs in no time.
9191
In case you have any further questions don't hesitate joining our [Community Discord](https://discord.gg/T9GzreAwPH).
9292

-164 KB
Binary file not shown.
-191 KB
Binary file not shown.

packages/vue/README.md

+71-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,74 @@
1-
# [WIP] Vue
1+
<img src="https://raw.githubusercontent.com/agile-ts/agile/master/packages/vue/static/header_background.png" alt="Vue Integration">
22

33
> Integrate AgileTs into Vue
44
5-
Much todo lol
5+
<br />
6+
7+
<a href="https://github.com/agile-ts/agile">
8+
<img src="https://img.shields.io/github/license/agile-ts/agile.svg?label=license&style=flat&colorA=293140&colorB=4a4872" alt="GitHub License"/></a>
9+
<a href="https://npm.im/@agile-ts/vue">
10+
<img src="https://img.shields.io/npm/v/@agile-ts/vue.svg?label=npm&style=flat&colorA=293140&colorB=4a4872" alt="npm version"/></a>
11+
<a href="https://npm.im/@agile-ts/vue">
12+
<img src="https://img.shields.io/bundlephobia/min/@agile-ts/vue.svg?label=minified%20size&style=flat&colorA=293140&colorB=4a4872" alt="npm minified size"/></a>
13+
<a href="https://npm.im/@agile-ts/vue">
14+
<img src="https://img.shields.io/npm/dt/@agile-ts/vue.svg?label=downloads&style=flat&colorA=293140&colorB=4a4872" alt="npm total downloads"/></a>
15+
16+
17+
<br />
18+
19+
20+
<br />
21+
<img src="https://raw.githubusercontent.com/agile-ts/agile/master/packages/vue/static/what_does_this_integration_header.png" alt="What does this Integration?"/>
22+
23+
The `vue` package helps us to integrate AgileTs into a [Vue](https://vuejs.org/) environment
24+
and serves as an Interface to Vue.
25+
Its main task is to bind States to Vue Components.
26+
This binding ensures that AgileTs rerender the Component whenever a bound State mutates.
27+
It also offers some other valuable functionalities that optimize the workflow using AgileTs in a Vue project.
28+
29+
30+
<br />
31+
32+
33+
<br />
34+
<img src="https://raw.githubusercontent.com/agile-ts/agile/master/packages/vue/static/installation_header.png" alt="Installation"/>
35+
36+
```
37+
npm install @agile-ts/vue
38+
```
39+
The `vue` package is an extension of AgileTs and doesn't work without the [`core`](https://agile-ts.org/docs/core) package,
40+
which functions as the brain of AgileTs and is indispensable.
41+
Unfortunately, we can't combine each `core` with `vue` version.
42+
Therefore, we have created a table that shows which versions fit together without restrictions.
43+
44+
| @agile-ts/vue | @agile-ts/core | NPM Version | Supported Vue versions |
45+
| ---------------- | ----------------------- | ------------------------ | -------------------------|
46+
| v0.0.01+ | v0.0.16+ | v6+ | 2.x (3.x not tested) |
47+
48+
_Older Versions aren't supported anymore_
49+
50+
51+
<br />
52+
53+
54+
<br />
55+
<img src="https://raw.githubusercontent.com/agile-ts/agile/master/packages/vue/static/documentation_header.png" alt="Documentation"/>
56+
57+
Sounds AgileTs interesting to you?
58+
Checkout our **[documentation](https://agile-ts.org/docs/vue)**, to learn more.
59+
And I promise you, you will be able to use AgileTs in no time.
60+
In case you have any further questions don't hesitate joining our [Community Discord](https://discord.gg/T9GzreAwPH).
61+
62+
63+
<br />
64+
65+
66+
<br />
67+
<img src="https://raw.githubusercontent.com/agile-ts/agile/master/packages/vue/static/contribute_header.png" alt="Contribute"/>
68+
69+
Get a part of AgileTs and start contributing. We welcome any meaningful contribution 😀
70+
To find out more checkout the [CONTRIBUTING.md](https://github.com/agile-ts/agile/blob/master/CONTRIBUTING.md).
71+
72+
<a href="https://codeclimate.com/github/agile-ts/agile/coverage.svg">
73+
<img src="https://codeclimate.com/github/agile-ts/agile/badges/gpa.svg" alt="Maintainability"/>
74+
</a>
131 KB
Loading
134 KB
Loading
364 KB
Loading
176 KB
Loading
Loading

0 commit comments

Comments
 (0)