Skip to content

Commit

Permalink
chore: add symbolic link
Browse files Browse the repository at this point in the history
  • Loading branch information
zernonia committed Oct 4, 2024
1 parent d612dce commit 2026fcf
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 111 deletions.
86 changes: 0 additions & 86 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
47 changes: 22 additions & 25 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,28 @@
<br />
<p align="center">
<a href="https://github.com/radix-vue/radix-vue">
<a href="https://github.com/unovue/reka-ui">
<img src="https://reka-ui.com/logo.svg" alt="Logo" width="150" />
</a>

<h1 align="center">
Radix Vue
Reka UI
</h1>
<p align="center">
An unofficial Vue port of Radix UI. <br>
Radix is an unstyled, customisable UI Library with built in accessibility for building top quality design systems.

<p align="center">
Craft accessible web apps with <a href="https://vuejs.org/">Vue</a>.
<p>

<p align="center">
<a href='https://github.com/radix-vue/radix-vue/actions/workflows/test.yml'>
</a>
<a href="https://www.npmjs.com/package/radix-vue" target="__blank"><img src="https://img.shields.io/npm/v/radix-vue?style=flat&colorA=002438&colorB=41c399" alt="NPM version"></a>
<a href="https://www.npmjs.com/package/radix-vue" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/radix-vue?flat&colorA=002438&colorB=41c399"></a>
<a href="https://github.com/radix-vue/radix-vue" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/radix-vue/radix-vue?flat&colorA=002438&colorB=41c399"></a>
<a href="https://www.npmjs.com/package/reka-ui" target="__blank"><img src="https://img.shields.io/npm/v/reka-ui?style=flat&colorA=002438&colorB=41c399" alt="NPM version"></a>
<a href="https://www.npmjs.com/package/reka-ui" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/reka-ui?flat&colorA=002438&colorB=41c399"></a>
<a href="https://github.com/unovue/reka-ui" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/unovue/reka-ui?flat&colorA=002438&colorB=41c399"></a>
</p>

<p align="center">
<a href="https://chat.radix-vue.com"><b>Get involved!</b></a>
<a href="https://chat.unovue.com"><b>Get involved!</b></a>
</p>
<p align="center">
<a href="https://radix-vue.com">Documentation</a> | <a href="https://reka-ui.com/overview/getting-started.html">Getting Started</a> | <a href="https://reka-ui.com/">Examples</a> | <a href="https://reka-ui.com/overview/introduction.html">Why Radix Vue?</a>
<a href="https://reka-ui.com">Documentation</a> | <a href="https://reka-ui.com/docs/overview/getting-started">Getting Started</a> | <a href="https://reka-ui.com/examples">Examples</a> | <a href="https://reka-ui.com/docs/overview/introduction">Why Reka UI?</a>
</p>

![hero image](https://reka-ui.com/og.jpg)
Expand All @@ -34,22 +31,22 @@ Radix is an unstyled, customisable UI Library with built in accessibility for bu
## Installation

```bash
pnpm add radix-vue
pnpm add reka-ui
```
```bash
npm install radix-vue
npm install reka-ui
```
```bash
yarn add radix-vue
yarn add reka-ui
```

## Documentation

For full documentation, visit [radix-vue.com](https://radix-vue.com).
For full documentation, visit [reka-ui.com](https://reka-ui.com).

## Releases

For changelog, visit [releases](https://github.com/radix-vue/radix-vue/releases).
For changelog, visit [releases](https://github.com/unovue/reka-ui/releases).

## Contributing

Expand All @@ -61,6 +58,7 @@ We would love to have your contributions! All PRs all welcomed! We need help bui

1. Clone the repo
2. Run `pnpm i`
3. Run `pnpm build` to run build `reka-ui` locally
3. Run `pnpm docs:dev` to run vitepress
4. Open `http://localhost:5173`

Expand All @@ -70,20 +68,19 @@ We would love to have your contributions! All PRs all welcomed! We need help bui
2. Run `pnpm i`
3. Run `pnpm story:dev` to run histoire (storybook)
4. Open `http://localhost:6006`
5. Run `pnpm test` to test changes

## Authors
## Core Team

- [Khairul Haaziq](https://github.com/khairulhaaziq)
- [Mujahid Anuar](https://github.com/mujahidfa)
- [Zernonia](https://github.com/zernonia)
- [Khairul Haaziq](https://github.com/k11q)
- [Mujahid Anuar](https://github.com/mujahidfa)

## Credits

All credits go to these open-source works and resources

- [Radix UI](https://radix-ui.com) for doing all the hard work to make sure components are accessible
- [Floating UI](https://floating-ui.com) for creating powerful components that as the base of many Radix Vue components
- [VueUse](https://vueuse.org) for providing many useful utilities.
- [Ark UI](https://ark-ui.com) for the `<Primitive>` component
- [Radix Svelte](https://radix-svelte.com)
- [Radix UI](https://radix-ui.com)
- [React Spectrum](https://react-spectrum.adobe.com/index.html)
- [Floating UI](https://floating-ui.com)
- [Headless UI](https://headlessui.com)

0 comments on commit 2026fcf

Please sign in to comment.