From dd2ddc8d1c37faf662d63f8e36d8017fb8a03dc0 Mon Sep 17 00:00:00 2001 From: zce Date: Sat, 18 Nov 2023 12:41:03 +0800 Subject: [PATCH] docs: readme --- docs/logo.svg | 22 ++++++++++++++++++++++ readme.md | 44 +++++++++++++++++++++++++++++++++++--------- 2 files changed, 57 insertions(+), 9 deletions(-) create mode 100644 docs/logo.svg diff --git a/docs/logo.svg b/docs/logo.svg new file mode 100644 index 0000000..6cd824d --- /dev/null +++ b/docs/logo.svg @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + diff --git a/readme.md b/readme.md index f7684f2..7c2f41d 100644 --- a/readme.md +++ b/readme.md @@ -1,16 +1,42 @@ -# :construction: velite +
+

VELITE

+

Turns Markdown, YAML, JSON, or other files into an app's data layer based on a schema.

+

+ Build Status + + License + NPM Version + Node Version +
+ Code Style + NPM Downloads + Install Size + Repo Size + +

+ +
+ +:construction: he documentation is not yet complete, but the functionality is mostly stable, although there is still a possibility of significant changes being made. -> Turns Markdown, YAML, JSON, or other files into an app's data layer based on a schema. +However, I have provided a complete [example](example) for your reference. -[![Build Status][actions-img]][actions-url] -[![License][license-img]][license-url] -[![NPM Version][version-img]][version-url] -[![NPM Downloads][downloads-img]][downloads-url] -[![Code Style][style-img]][style-url] +## Introduction -The documentation is not yet complete, but the functionality is mostly stable, although there is still a possibility of significant changes being made. +"Velite" comes from the English word "elite". -However, I have provided a complete [example](example) for your reference. +> "Velite" itself is the code name for Napoleon's elite army. + +### Features + +- Easy to use +- Light-weight +- Still powerful +- High efficiency +- Less runtime dependencies +- Configurable +- TypeScript support +- ESM ## TODOs