Skip to content

Commit 4aa4bc7

Browse files
chore: update readme (#283)
* update readme * ci: apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent b4d53e5 commit 4aa4bc7

3 files changed

Lines changed: 118 additions & 24 deletions

File tree

README.md

Lines changed: 92 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,101 @@
11
<img src="https://static.scarf.sh/a.png?x-pxid=be2d8a11-9712-4c1d-9963-580b2d4fb133" />
22

3-
![TanStack Config Header](https://github.com/TanStack/config/raw/main/media/repo-header.png)
4-
5-
Configuration and tools for publishing and maintaining high-quality JavaScript packages
6-
7-
<a href="https://twitter.com/intent/tweet?button_hashtag=TanStack" 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://discord.com/invite/WrRKjPJ" target="\_parent">
10-
<img alt="" src="https://img.shields.io/badge/Discord-TanStack-%235865F2" />
11-
</a><a href="https://www.npmjs.com/package/@tanstack/config" target="\_parent">
12-
<img alt="" src="https://img.shields.io/npm/dm/@tanstack/config.svg" />
13-
</a><a href="https://bundlephobia.com/package/@tanstack/config@latest" target="\_parent">
14-
<img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/config" />
15-
</a><a href="#badge">
3+
<div align="center">
4+
<img src="./media/header_config.png" alt="TanStack Config" >
5+
</div>
6+
7+
<br />
8+
9+
<div align="center">
10+
<a href="https://www.npmjs.com/package/@tanstack/config" target="\_parent">
11+
<img alt="" src="https://img.shields.io/npm/dm/@tanstack/config.svg" alt="npm downloads" />
12+
</a>
13+
<a href="https://github.com/TanStack/config/" target="\_parent">
14+
<img alt="" src="https://img.shields.io/github/stars/TanStack/config.svg?style=social&label=Star" alt="github stars" />
15+
</a>
16+
</div>
17+
18+
<div align="center">
19+
<a href="#badge">
1620
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
17-
</a><a href="https://github.com/TanStack/config/discussions">
18-
<img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
19-
</a><a href="https://bestofjs.org/projects/tanstack-config"><img alt="Best of JS" src="https://img.shields.io/endpoint?url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=TanStack%2Fconfig%26since=daily" /></a><a href="https://github.com/TanStack/config/" target="\_parent">
20-
<img alt="" src="https://img.shields.io/github/stars/TanStack/config.svg?style=social&label=Star" />
21-
</a><a href="https://twitter.com/tannerlinsley" target="\_parent">
22-
<img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
23-
</a> <a href="https://gitpod.io/from-referrer/">
24-
<img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"/>
21+
</a>
22+
<a href="#badge">
23+
<img src="https://img.shields.io/github/v/release/tanstack/config" alt="Release"/>
24+
</a>
25+
<img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
2526
</a>
27+
</div>
2628

27-
Enjoy this library? Try the entire [TanStack](https://tanstack.com)! [TanStack Query](https://github.com/TanStack/query), [TanStack Table](https://github.com/TanStack/table), [TanStack Router](https://github.com/tanstack/router), [TanStack Virtual](https://github.com/tanstack/virtual), [TanStack Form](https://github.com/tanstack/form), [React Charts](https://github.com/TanStack/react-charts), [React Ranger](https://github.com/TanStack/ranger)
29+
<div align="center">
30+
31+
### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
32+
</div>
2833

29-
## Visit [tanstack.com/config](https://tanstack.com/config) for docs, guides, API and more!
34+
# TanStack Config
3035

31-
### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
36+
An opinionated toolkit for building, versioning, and publishing high‑quality JS/TS packages with minimal setup and consistent results.
37+
38+
- Vite‑powered builds with extendable workflows
39+
- Automated publishing, versioning & changelogs
40+
- Publint‑compliant with sensible defaults
41+
- Minimal configuration for faster, hassle‑free setup
42+
43+
### <a href="https://tanstack.com/config">Read the docs →</b></a>
44+
45+
## Get Involved
46+
47+
- We welcome issues and pull requests!
48+
- Participate in [GitHub discussions](https://github.com/TanStack/config/discussions)
49+
- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
50+
- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
51+
52+
## Partners
53+
54+
<table align="center">
55+
<tr>
56+
<td>
57+
<a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" >
58+
<picture>
59+
<source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-CMcuvjEy.svg" height="40" />
60+
<source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" />
61+
<img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
62+
</picture>
63+
</a>
64+
</td>
65+
<td>
66+
<a href="https://www.cloudflare.com?utm_source=tanstack">
67+
<picture>
68+
<source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-DQDB7UaL.svg" height="60" />
69+
<source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" />
70+
<img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
71+
</picture>
72+
</a>
73+
</td>
74+
</tr>
75+
</table>
76+
77+
<div align="center">
78+
<img src="./media/partner_logo.svg" alt="Config & you?" height="65">
79+
<p>
80+
We're looking for TanStack Config Partners to join our mission! Partner with us to push the boundaries of TanStack Config and build amazing things together.
81+
</p>
82+
<a href="mailto:partners@tanstack.com?subject=TanStack Config Partnership"><b>LET'S CHAT</b></a>
83+
</div>
84+
85+
## Explore the TanStack Ecosystem
86+
87+
- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
88+
- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
89+
- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
90+
- <a href="https://github.com/tanstack/pacer"><b>TanStack Pacer</b></a> – Debouncing, throttling, batching
91+
- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
92+
- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
93+
- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
94+
- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
95+
- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
96+
- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
97+
- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
98+
99+
… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>
32100

33101
<!-- Use the force, Luke! -->

media/header_config.png

149 KB
Loading

media/partner_logo.svg

Lines changed: 26 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)