Skip to content

Commit e6f5c73

Browse files
authored
fix: add readme to packages (#80)
1 parent e93602a commit e6f5c73

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

packages/ranger/README.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
![React Ranger Header](https://github.com/tanstack/ranger/raw/main/media/headerv1.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" />
13+
</a><a href="#badge">
14+
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
15+
</a><a href="https://github.com/tanstack/ranger/discussions">
16+
<img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
17+
</a><a href="https://github.com/tanstack/ranger" target="\_parent">
18+
<img alt="" src="https://img.shields.io/github/stars/tanstack/ranger.svg?style=social&label=Star" />
19+
</a><a href="https://twitter.com/tannerlinsley" target="\_parent">
20+
<img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
21+
</a>
22+
23+
<br />
24+
<br />
25+
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)
27+
28+
## Visit [tanstack.com/ranger](https://tanstack.com/ranger) for docs, guides, API and more!
29+
30+
## Quick Features
31+
32+
- Headless!
33+
- Single or Multiple Handles
34+
- Handle Devider Items
35+
- Custom Steps or Step-Size
36+
- Custom Ticks
37+
38+
<!-- Force -->

packages/react-ranger/README.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
![React Ranger Header](https://github.com/tanstack/ranger/raw/main/media/headerv1.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" />
13+
</a><a href="#badge">
14+
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
15+
</a><a href="https://github.com/tanstack/ranger/discussions">
16+
<img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
17+
</a><a href="https://github.com/tanstack/ranger" target="\_parent">
18+
<img alt="" src="https://img.shields.io/github/stars/tanstack/ranger.svg?style=social&label=Star" />
19+
</a><a href="https://twitter.com/tannerlinsley" target="\_parent">
20+
<img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
21+
</a>
22+
23+
<br />
24+
<br />
25+
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)
27+
28+
## Visit [tanstack.com/ranger](https://tanstack.com/ranger) for docs, guides, API and more!
29+
30+
## Quick Features
31+
32+
- Headless!
33+
- Single or Multiple Handles
34+
- Handle Devider Items
35+
- Custom Steps or Step-Size
36+
- Custom Ticks
37+
38+
<!-- Force -->

0 commit comments

Comments
 (0)