Skip to content

Commit 0b0190e

Browse files
committed
Update readme
1 parent 9ddd1df commit 0b0190e

File tree

2 files changed

+17
-43
lines changed

2 files changed

+17
-43
lines changed

README.md

+17-43
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
![React Ranger Header](https://github.com/tannerlinsley/react-ranger/raw/main/media/header.png)
2-
3-
<img src='https://github.com/tanstack/ranger/raw/main/media/logo.png' width='300'/>
4-
5-
Hooks for building range and multi-range sliders in React
6-
7-
<a href="https://twitter.com/search?q=%23TanStack" target="\_parent">
8-
<img alt="#TanStack" src="https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack">
9-
</a><a href="https://github.com/tanstack/ranger/actions?query=workflow%3A%22react-ranger+tests%22">
10-
<img src="https://github.com/tanstack/ranger/workflows/react-ranger%20tests/badge.svg" />
11-
</a><a href="https://npmjs.com/package/react-ranger" target="\_parent">
12-
<img alt="" src="https://img.shields.io/npm/dm/react-ranger.svg" />
13-
</a><a href="https://bundlephobia.com/result?p=react-ranger@latest" target="\_parent">
14-
<img alt="" src="https://badgen.net/bundlephobia/minzip/react-ranger@latest" />
1+
![React Ranger Header](https://github.com/tanstack/ranger/raw/main/media/header.png)
2+
3+
Headless UI for building ranger component in TS/JS and React
4+
5+
<a href="https://twitter.com/intent/tweet?button_hashtag=TanStack" target="\_parent">
6+
<img alt="#TanStack" src="https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack" />
7+
</a><a href="https://github.com/TanStack/ranger/actions/workflows/ci.yml">
8+
<img src="https://github.com/tanstack/ranger/actions/workflows/ci.yml/badge.svg" />
9+
</a><a href="https://npmjs.com/package/@tanstack/ranger-core" target="\_parent">
10+
<img alt="" src="https://img.shields.io/npm/dm/@tanstack/ranger-core.svg" />
11+
</a><a href="https://bundlephobia.com/result?p=@tanstack/ranger@latest" target="\_parent">
12+
<img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/ranger@latest" />
1513
</a><a href="#badge">
1614
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
1715
</a><a href="https://github.com/tanstack/ranger/discussions">
@@ -22,13 +20,12 @@ Hooks for building range and multi-range sliders in React
2220
<img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
2321
</a>
2422

25-
Enjoy this library? Try them all! [React Table](https://github.com/tannerlinsley/react-table), [React Query](https://github.com/tannerlinsley/react-query), [React Form](https://github.com/tannerlinsley/react-form), [React Charts](https://github.com/tannerlinsley/react-charts)
23+
<br />
24+
<br />
2625

27-
<p align="center">
28-
<img src='https://github.com/tanstack/ranger/raw/main/media/screenshot.png' width="700"/>
29-
</p>
26+
Enjoy this library? Try the entire [TanStack](https://tanstack.com)! [React Query](https://github.com/TanStack/react-query), [TanStack Table](https://github.com/TanStack/table), [React Charts](https://github.com/TanStack/react-charts)
3027

31-
## Visit [/docs](https://github.com/tanstack/react-ranger/tree/alpha/docs) for docs, guides, API and more!
28+
## Visit [tanstack.com/ranger](https://tanstack.com/ranger) for docs, guides, API and more!
3229

3330
## Quick Features
3431

@@ -37,28 +34,5 @@ Enjoy this library? Try them all! [React Table](https://github.com/tannerlinsley
3734
- Handle Devider Items
3835
- Custom Steps or Step-Size
3936
- Custom Ticks
40-
- <a href="https://bundlephobia.com/result?p=react-ranger@latest" target="\_parent">
41-
<img alt="" src="https://badgen.net/bundlephobia/minzip/react-ranger@latest" />
42-
</a>
43-
44-
# Installation
45-
46-
```bash
47-
$ npm i --save react-ranger
48-
# or
49-
$ yarn add react-ranger
50-
```
51-
52-
## How to help?
53-
54-
- Try out the already-migrated examples
55-
- Try it out in your own projects.
56-
- Introspect the types! Even without the docs finished, the library ships with 100% typescript to help you explore its capabilities.
57-
- [Read the contribution guidelines](https://github.com/tanstack/react-table/tree/alpha/CONTRIBUTING.md)
58-
- Write some docs! Start with the [API docs](https://github.com/tanstack/react-table/tree/alpha/docs/docs/api-reference) and try adding some information about one or more of the features. The types do a decent job of showing what's supported and the capabilities of the library.
59-
- Try your hand at migrating an example to v8! The todo list for the examples is above!
60-
- **Using a plugin?** Try rewriting your plugin (v8 doesn't have a plugin system any more) as a wrapping hook/function that uses `useTable` internally. The new API is much more powerful and easier to compose. If you find something you can't figure out, let us know and we'll add it to the API.
61-
62-
### [Become a Sponsor](https://github.com/sponsors/tannerlinsley/)
6337

64-
<!-- USE THE FORCE, LUKE -->
38+
<!-- Force -->

media/header.png

20 KB
Loading

0 commit comments

Comments
 (0)