From d93e8d4a4fe1dbc0945f8031acbc5667227dbb46 Mon Sep 17 00:00:00 2001 From: Evgeny Date: Mon, 12 Aug 2024 23:31:25 -0400 Subject: [PATCH] docs updates --- README.md | 20 +++++++++++++++++++- docs/docs/.vitepress/config.ts | 11 ++++++++++- docs/docs/pages/getting-started.md | 6 +++--- docs/docs/pages/how-it-works.md | 2 +- 4 files changed, 33 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9ed6585..b46073d 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,25 @@ – Only 1kb in size!
– Production Ready
-## How Does it Work +## What is ivue? + +## **ivue** is +
+–  Simple like Options API
+–  Flexible like Composition API
+–  Extensible like TypeScript Classes API
+
+ +**ivue** is a powerful tool because it fully aligns itself with JavaScript / TypeScript Class API. + +**ivue** gives you a class based Composable capabilities with Inheritance and all the power of TypeScript Classes. + +**ivue** mitigates the downsides of both Composition API and Options API, uses only their strengths and brings back Object Oriented Programming to allow the development of complex and scalable apps. + +**ivue** is fully interoperable with Composition API and does not work against, but rather with it, so you can use all of ecosystems composables seamlessly. + +**ivue** also offers a set of functions and utility types to make extensible & exportable props defaults, extensible emits and extensible slots possible. + ## Examples diff --git a/docs/docs/.vitepress/config.ts b/docs/docs/.vitepress/config.ts index 57eb89d..eba0cce 100644 --- a/docs/docs/.vitepress/config.ts +++ b/docs/docs/.vitepress/config.ts @@ -92,7 +92,7 @@ export default defineConfig({ }, ], }, - + { text: 'API' }, { collapsed: false, text: 'Core Functions', @@ -112,6 +112,7 @@ export default defineConfig({ }, { + collapsed: false, text: 'Utility Types', items: [ { @@ -123,6 +124,14 @@ export default defineConfig({ { text: 'UnwrapComposable', link: '/pages/api#unwrapcomposable' }, ], }, + + { + collapsed: false, + text: 'Source Code', + items: [ + { text: 'Browse Code', link: '/pages/browse-code' }, + ], + }, ], }, base: '/ivue/', diff --git a/docs/docs/pages/getting-started.md b/docs/docs/pages/getting-started.md index 0e2f2bb..72136c8 100644 --- a/docs/docs/pages/getting-started.md +++ b/docs/docs/pages/getting-started.md @@ -18,8 +18,8 @@ pnpm i ivue ## Install by Copying -`ivue` is designed to be easily shareable and installable so if you are running TypeScript, you can just copy the `index.ts` rename it to -`ivue.ts` in your repo and you are done: +`ivue` is designed to be easily shareable and installable so if you are running TypeScript, you can just copy the +`ivue.ts` into your repo and you are done: :::details Click to expand the latest `ivue` source code to copy :::code-group @@ -28,5 +28,5 @@ pnpm i ivue Or [Copy from GitHub](https://github.com/infinite-system/ivue/blob/main/src/index.ts) ::: tip NOTE -This installation path is recommended only if you quickly want to tinker with the internals of ivue, as you won't be getting the latest updates. Also note that this code comes from github `main` branch latest which might also be in beta and not fully pushed to `npm`. +This installation path is recommended only if you quickly want to tinker with the internals of ivue, as you won't be getting the latest updates. Also note that this code comes from github `main` branch latest which might also be in beta and not fully published to `npm`. ::: \ No newline at end of file diff --git a/docs/docs/pages/how-it-works.md b/docs/docs/pages/how-it-works.md index feaa1bb..9ed6e63 100644 --- a/docs/docs/pages/how-it-works.md +++ b/docs/docs/pages/how-it-works.md @@ -52,7 +52,7 @@ Utility Types help to achieve the rest of `ivue` capabilities Or [See on GitHub](https://github.com/infinite-system/ivue/blob/main/src/index.ts) ## 100% Vue 3 Compatible -`.toRefs()` allows the object to be converted to native composable structure with full `.value`s, so it can interoperate with native composables if needed. `.toRefs()` is also often used to get refs for `v-bind()` in css styles. +`.toRefs()` allows the object to be converted to Vue 3 native composable structure with full `.value`s, so it can interoperate with native composables if needed. `.toRefs()` is also often used to get refs for `v-bind()` in css styles. ## 100% TypeScript Support