Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
KermanX committed Jan 19, 2024
1 parent 3c00eee commit 79f7b38
Showing 1 changed file with 47 additions and 28 deletions.
75 changes: 47 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,27 @@
# Refina.js
# Refina.js [![npm](https://img.shields.io/npm/v/refina?label=core&color=green)](https://www.npmjs.com/package/refina)

![npm](https://img.shields.io/npm/v/refina?label=core&color=green)
_An extremely **refined** web framework._

[**Documentation**](https://refina.vercel.app/) |
[**Examples**](https://gallery.refina.vercel.app/) |
[**Get Started**](https://refina.vercel.app/guide/introduction.html) |
[**Why Refina**](https://refina.vercel.app/guide/why.html)

### 🆕 An extremely **refined** web framework. 🆕

⚡ Line of code reduced to about `60%~70%` of traditional frameworks. _(Approximately, based on real projects)_

⚡ Development efficiency is `1.4x~1.6x` of traditional frameworks. _(Approximately, based on real projects)_

✅ ImGUI-like state management, which gives you the experience like Svelte, but with much less code.

✅ No DSL like JSX or Vue SFC, just plain TypeScript, with a little bit comptime transformation.
Yet another web framework? Yes, but it's different from others **from the ground up**. 🆕

✅ Full TypeScript support, everything is typed, even some dynamic states.
**`1.4x~1.6x`** development efficiency.

No need to write any end tags.
💡 No need to use `ref()`, states can be Intrinsic JS values.

✅ Use positional parameters, which are more concise than named parameters.
🧩 No new syntax, use plain TypeScript or JavaScript.

📦 The adaptation of [MdUI v2](https://github.com/zdhxiong/mdui) component library is available.
🔑 Fully Typed APIs.

📦 The rewrite of [Fluent UI v9](https://react.fluentui.dev/) component library is partially available.
🔥 Hot Module Replacement.

🛢️ Work well with [Tailwind CSS](https://tailwindcss.com/).
✍️ No closing tags.

🛢️ You can also use the CSS-in-JS library [Griffel](https://griffel.js.org/).
🪗 Use positional parameters, rather than named parameters.

🛠️ Work well with [Vite](https://vitejs.dev/).
[**Documentation**](https://refina.vercel.app/) |
[**中文文档**](https://refinajs.github.io/refina/zh/) |
[**Get Started**](https://refina.vercel.app/guide/introduction.html) |
[**Why Refina**](https://refina.vercel.app/guide/why.html)

## Example

Expand All @@ -48,7 +38,7 @@ $app.use(Basics)(_ => {
_.textInput(name);

if (_.button("Click me!", name.length === 0)) {
// returns true if the button is clicked
// when the button is clicked
count++;
console.log(_.$ev);
// (TS) ^? :MouseEvent
Expand All @@ -61,11 +51,40 @@ $app.use(Basics)(_ => {
});
```

> There are more examples in the [documentation](https://refina.vercel.app/).
### Getting Started

You can:

- Read the [Documentation](https://refina.vercel.app/) ([中文翻译](https://refinajs.github.io/refina/zh/)).

- Try the [Tutorial](https://refina.vercel.app/tutorial) ([中文翻译](https://refinajs.github.io/refina/zh/tutorial)).

- Try the [Playground](https://refina.vercel.app/misc/playground) ([国内版](https://refinajs.github.io/refina/zh/misc/playground)).

- Run `pnpm create refina@latest` to create a new project.

### Ecosystem

📦 Basic components are available. ([EXAMPLE](https://gallery.refina.vercel.app/#gh-login) |
[NPM](https://www.npmjs.com/package/@refina/basic-components))

📦 The adaptation of [MdUI v2](https://github.com/zdhxiong/mdui) component library is available.
([EXAMPLE](https://gallery.refina.vercel.app/#mdui) |
[NPM](https://www.npmjs.com/package/@refina/mdui))

📦 The rewrite of [Fluent UI v9](https://react.fluentui.dev/) component library is partially available.
([EXAMPLE](https://gallery.refina.vercel.app/#fluentui))

🛢️ Work well with [Tailwind CSS](https://tailwindcss.com/).
([EXAMPLE](https://gallery.refina.vercel.app/#gh-login))

🛢️ You can also use the CSS-in-JS library [Griffel](https://griffel.js.org/).

🛠️ Work well with [Vite](https://vitejs.dev/). ([PLUGIN](https://www.npmjs.com/package/vite-plugin-refina))

## Refina.js 简介
### 设计理念

> 注:以下是一些早期的设计理念,部分内容已过时
> 注:以下是一些较早期的设计理念,部分内容已被更新代替
### 有许多成熟的前端框架,还需要一个新的吗?

Expand Down

0 comments on commit 79f7b38

Please sign in to comment.