Skip to content

Commit d54995e

Browse files
mrlubosmrlubos
authored
Merge pull request #3735 from hey-api/refactor/readme-sync
docs: add readme sync
2 parents b877338 + 6710a42 commit d54995e

12 files changed

Lines changed: 618 additions & 1 deletion

File tree

‎package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
"lint:fix": "oxfmt . && eslint . --fix",
3232
"lint:fix:next": "oxfmt . && eslint . --fix && uv run ruff check --fix packages/openapi-python/src/py-compiler/__snapshots__",
3333
"prepare": "husky",
34+
"readme:sync": "tsx scripts/readme-sync.ts",
3435
"test:changelog": "vitest run __tests__/*.test.ts",
3536
"test:changelog:watch": "vitest watch __tests__/*.test.ts",
3637
"test:coverage": "turbo run build && vitest run --coverage",

‎packages/codegen-core/README.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,131 @@
1414

1515
This is an internal framework. Visit [Hey API](https://heyapi.dev/) to discover our products.
1616

17+
<!-- template-contributing-start -->
18+
19+
## Contributing
20+
21+
Want to see your code in products used by millions?
22+
23+
Start with our [Contributing](https://heyapi.dev/openapi-ts/community/contributing) guide and release your first feature.
24+
25+
<!-- template-contributing-end -->
26+
27+
<!-- template-sponsors-start -->
28+
29+
## Sponsors
30+
31+
Hey API is sponsor-funded. If you rely on Hey API in production, consider becoming a [sponsor](https://github.com/sponsors/hey-api) to accelerate the roadmap.
32+
33+
<h3 align="center">Gold</h3>
34+
35+
<table align="center" style="justify-content: center;align-items: center;display: flex;">
36+
<tbody>
37+
<tr>
38+
<td align="center" width="336px">
39+
<p></p>
40+
<p>
41+
<a href="https://kutt.to/pkEZyc" target="_blank">
42+
<picture height="50px">
43+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/.gen/stainless-logo-wordmark-480w.jpeg">
44+
<img alt="Stainless logo" height="50px" src="https://heyapi.dev/assets/.gen/stainless-logo-wordmark-480w.jpeg">
45+
</picture>
46+
</a>
47+
<br/>
48+
Best-in-class developer interfaces for your API.
49+
<br/>
50+
<a href="https://kutt.to/pkEZyc" style="text-decoration:none;" target="_blank">
51+
stainless.com
52+
</a>
53+
</p>
54+
<p></p>
55+
</td>
56+
<td align="center" width="336px">
57+
<p></p>
58+
<p>
59+
<a href="https://kutt.to/QM9Q2N" target="_blank">
60+
<picture height="50px">
61+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/opencode/logo-light.svg">
62+
<img alt="Opencode logo" height="50px" src="https://heyapi.dev/assets/opencode/logo-dark.svg">
63+
</picture>
64+
</a>
65+
<br/>
66+
The open source coding agent.
67+
<br/>
68+
<a href="https://kutt.to/QM9Q2N" style="text-decoration:none;" target="_blank">
69+
opencode.ai
70+
</a>
71+
</p>
72+
<p></p>
73+
</td>
74+
</tr>
75+
</tbody>
76+
</table>
77+
78+
<h3 align="center">Silver</h3>
79+
80+
<table align="center" style="justify-content: center;align-items: center;display: flex;">
81+
<tbody>
82+
<tr>
83+
<td align="center" width="172px">
84+
<a href="https://kutt.to/skQUVd" target="_blank">
85+
<picture height="40px">
86+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/scalar/logo-light.svg">
87+
<img alt="Scalar logo" height="40px" src="https://heyapi.dev/assets/scalar/logo-dark.svg">
88+
</picture>
89+
</a>
90+
<br/>
91+
<a href="https://kutt.to/skQUVd" style="text-decoration:none;" target="_blank">
92+
scalar.com
93+
</a>
94+
</td>
95+
<td align="center" width="172px">
96+
<a href="https://kutt.to/Dr9GuW" target="_blank">
97+
<picture height="40px">
98+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/fastapi/logo-light.svg">
99+
<img alt="FastAPI logo" height="40px" src="https://heyapi.dev/assets/fastapi/logo-dark.svg">
100+
</picture>
101+
</a>
102+
<br/>
103+
<a href="https://kutt.to/Dr9GuW" style="text-decoration:none;" target="_blank">
104+
fastapi.tiangolo.com
105+
</a>
106+
</td>
107+
</tr>
108+
</tbody>
109+
</table>
110+
111+
<h3 align="center">Bronze</h3>
112+
113+
<table align="center" style="justify-content: center;align-items: center;display: flex;">
114+
<tbody>
115+
<tr>
116+
<td align="center" width="136px">
117+
<a href="https://kutt.to/YpaKsX" target="_blank">
118+
<picture height="34px">
119+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/.gen/kinde-logo-wordmark-dark-480w.webp">
120+
<img alt="Kinde logo" height="34px" src="https://heyapi.dev/assets/.gen/kinde-logo-wordmark-480w.jpeg">
121+
</picture>
122+
</a>
123+
</td>
124+
<td align="center" width="136px">
125+
<a href="https://kutt.to/KkqSaw" target="_blank">
126+
<picture height="34px">
127+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/cella/logo-light.svg">
128+
<img alt="Cella logo" height="34px" src="https://heyapi.dev/assets/cella/logo-dark.svg">
129+
</picture>
130+
</a>
131+
</td>
132+
</tr>
133+
</tbody>
134+
</table>
135+
136+
<!-- template-sponsors-end -->
137+
138+
<!-- template-license-start -->
139+
17140
## License
18141

19142
Released under the [MIT License](https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md).
143+
144+
<!-- template-license-end -->

‎packages/json-schema-ref-parser/README.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,132 @@ await new $RefParser().bundle({
102102
},
103103
});
104104
```
105+
106+
<!-- template-contributing-start -->
107+
108+
## Contributing
109+
110+
Want to see your code in products used by millions?
111+
112+
Start with our [Contributing](https://heyapi.dev/openapi-ts/community/contributing) guide and release your first feature.
113+
114+
<!-- template-contributing-end -->
115+
116+
<!-- template-sponsors-start -->
117+
118+
## Sponsors
119+
120+
Hey API is sponsor-funded. If you rely on Hey API in production, consider becoming a [sponsor](https://github.com/sponsors/hey-api) to accelerate the roadmap.
121+
122+
<h3 align="center">Gold</h3>
123+
124+
<table align="center" style="justify-content: center;align-items: center;display: flex;">
125+
<tbody>
126+
<tr>
127+
<td align="center" width="336px">
128+
<p></p>
129+
<p>
130+
<a href="https://kutt.to/pkEZyc" target="_blank">
131+
<picture height="50px">
132+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/.gen/stainless-logo-wordmark-480w.jpeg">
133+
<img alt="Stainless logo" height="50px" src="https://heyapi.dev/assets/.gen/stainless-logo-wordmark-480w.jpeg">
134+
</picture>
135+
</a>
136+
<br/>
137+
Best-in-class developer interfaces for your API.
138+
<br/>
139+
<a href="https://kutt.to/pkEZyc" style="text-decoration:none;" target="_blank">
140+
stainless.com
141+
</a>
142+
</p>
143+
<p></p>
144+
</td>
145+
<td align="center" width="336px">
146+
<p></p>
147+
<p>
148+
<a href="https://kutt.to/QM9Q2N" target="_blank">
149+
<picture height="50px">
150+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/opencode/logo-light.svg">
151+
<img alt="Opencode logo" height="50px" src="https://heyapi.dev/assets/opencode/logo-dark.svg">
152+
</picture>
153+
</a>
154+
<br/>
155+
The open source coding agent.
156+
<br/>
157+
<a href="https://kutt.to/QM9Q2N" style="text-decoration:none;" target="_blank">
158+
opencode.ai
159+
</a>
160+
</p>
161+
<p></p>
162+
</td>
163+
</tr>
164+
</tbody>
165+
</table>
166+
167+
<h3 align="center">Silver</h3>
168+
169+
<table align="center" style="justify-content: center;align-items: center;display: flex;">
170+
<tbody>
171+
<tr>
172+
<td align="center" width="172px">
173+
<a href="https://kutt.to/skQUVd" target="_blank">
174+
<picture height="40px">
175+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/scalar/logo-light.svg">
176+
<img alt="Scalar logo" height="40px" src="https://heyapi.dev/assets/scalar/logo-dark.svg">
177+
</picture>
178+
</a>
179+
<br/>
180+
<a href="https://kutt.to/skQUVd" style="text-decoration:none;" target="_blank">
181+
scalar.com
182+
</a>
183+
</td>
184+
<td align="center" width="172px">
185+
<a href="https://kutt.to/Dr9GuW" target="_blank">
186+
<picture height="40px">
187+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/fastapi/logo-light.svg">
188+
<img alt="FastAPI logo" height="40px" src="https://heyapi.dev/assets/fastapi/logo-dark.svg">
189+
</picture>
190+
</a>
191+
<br/>
192+
<a href="https://kutt.to/Dr9GuW" style="text-decoration:none;" target="_blank">
193+
fastapi.tiangolo.com
194+
</a>
195+
</td>
196+
</tr>
197+
</tbody>
198+
</table>
199+
200+
<h3 align="center">Bronze</h3>
201+
202+
<table align="center" style="justify-content: center;align-items: center;display: flex;">
203+
<tbody>
204+
<tr>
205+
<td align="center" width="136px">
206+
<a href="https://kutt.to/YpaKsX" target="_blank">
207+
<picture height="34px">
208+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/.gen/kinde-logo-wordmark-dark-480w.webp">
209+
<img alt="Kinde logo" height="34px" src="https://heyapi.dev/assets/.gen/kinde-logo-wordmark-480w.jpeg">
210+
</picture>
211+
</a>
212+
</td>
213+
<td align="center" width="136px">
214+
<a href="https://kutt.to/KkqSaw" target="_blank">
215+
<picture height="34px">
216+
<source media="(prefers-color-scheme: dark)" srcset="https://heyapi.dev/assets/cella/logo-light.svg">
217+
<img alt="Cella logo" height="34px" src="https://heyapi.dev/assets/cella/logo-dark.svg">
218+
</picture>
219+
</a>
220+
</td>
221+
</tr>
222+
</tbody>
223+
</table>
224+
225+
<!-- template-sponsors-end -->
226+
227+
<!-- template-license-start -->
228+
229+
## License
230+
231+
Released under the [MIT License](https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md).
232+
233+
<!-- template-license-end -->

‎packages/nuxt/README.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,25 @@
2222

2323
Access your projects and OpenAPI specifications in the [Hey API Platform](https://app.heyapi.dev/).
2424

25+
<!-- template-contributing-start -->
26+
2527
## Contributing
2628

2729
Want to see your code in products used by millions?
2830

2931
Start with our [Contributing](https://heyapi.dev/openapi-ts/community/contributing) guide and release your first feature.
3032

33+
<!-- template-contributing-end -->
34+
3135
## Documentation
3236

3337
Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more.
3438

39+
<!-- template-sponsors-start -->
40+
3541
## Sponsors
3642

37-
Help Hey API stay around for the long haul by becoming a [sponsor](https://github.com/sponsors/hey-api).
43+
Hey API is sponsor-funded. If you rely on Hey API in production, consider becoming a [sponsor](https://github.com/sponsors/hey-api) to accelerate the roadmap.
3844

3945
<h3 align="center">Gold</h3>
4046

@@ -139,10 +145,16 @@ Help Hey API stay around for the long haul by becoming a [sponsor](https://githu
139145
</tbody>
140146
</table>
141147

148+
<!-- template-sponsors-end -->
149+
142150
## Migrating
143151

144152
You can learn more on the [Migrating](https://heyapi.dev/openapi-ts/migrating) page.
145153

154+
<!-- template-license-start -->
155+
146156
## License
147157

148158
Released under the [MIT License](https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md).
159+
160+
<!-- template-license-end -->

0 commit comments

Comments
 (0)