Skip to content

Commit c8fd138

Browse files
ryanflorenceryanflorence
committed
docs: adjusted READMEs for the api docs generator
1 parent 6c13442 commit c8fd138

File tree

12 files changed

+39
-59
lines changed

12 files changed

+39
-59
lines changed

Diff for: ‎README.md

+16-31
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,28 @@
1-
# Welcome to React Router · [![npm package][npm-badge]][npm] [![build][build-badge]][build]
1+
[![npm package][npm-badge]][npm] [![build][build-badge]][build]
22

33
[npm-badge]: https://img.shields.io/npm/v/react-router-dom.svg?style=flat-square
44
[npm]: https://www.npmjs.org/package/react-router-dom
55
[build-badge]: https://img.shields.io/github/actions/workflow/status/remix-run/react-router/test.yml?branch=dev&style=square
66
[build]: https://github.com/remix-run/react-router/actions/workflows/test.yml
77

8-
React Router is a lightweight, fully-featured routing library for the [React](https://reactjs.org) JavaScript library. React Router runs anywhere React runs; on the web, on the server with node.js, or on any other Javascript platform that supports the [Web Fetch API][fetch-api].
8+
React Router is a multi-strategy router for React bridging the gap from React 18 to React 19. You can use it maximally as a React framework or minimally as a library with your own architecture.
99

10-
If you're new to React Router, we recommend you start with [the tutorial](https://reactrouter.com/en/main/start/tutorial).
11-
12-
If you're migrating to v6 from v5 (or v4, which is the same as v5), check out [the migration guide](/docs/upgrading/v5.md). If you're migrating from Reach Router, check out [the migration guide for Reach Router](/docs/upgrading/reach.md). If you need to find the code for v5, [it is on the `v5` branch](https://github.com/remix-run/react-router/tree/v5).
13-
14-
Documentation for v6 can be found [on our website](https://reactrouter.com/).
15-
16-
## Contributing
17-
18-
There are many different ways to contribute to React Router's development. If you're interested, check out [our contributing guidelines](CONTRIBUTING.md) to learn how you can get involved.
10+
- [Getting Started - Framework](https://reactrouter.com/start/framework/installation)
11+
- [Getting Started - Library](https://react.router.com/start/library/installation)
12+
- [Upgrade from v6](https://reactrouter.com/upgrading/v6)
13+
- [Upgrade from Remix](https://reactrouter.com/upgrading/remix)
14+
- [Changelog](https://github.com/remix-run/react-router/blob/main/CHANGELOG.md)
1915

2016
## Packages
2117

22-
This repository is a monorepo containing the following packages:
23-
24-
- [`@react-router/dev`](/packages/react-router-dev)
25-
- [`@react-router/express`](/packages/react-router-express)
26-
- [`@react-router/node`](/packages/react-router-node)
27-
- [`@react-router/serve`](/packages/react-router-serve)
28-
- [`react-router`](/packages/react-router)
29-
- [`react-router-dom`](/packages/react-router-dom)
30-
31-
## Changes
32-
33-
Detailed release notes for a given version can be found [on our releases page](https://github.com/remix-run/react-router/releases).
34-
35-
## Funding
36-
37-
You may provide financial support for this project by donating [via Open Collective](https://opencollective.com/react-router). Thank you for your support!
38-
39-
## About
18+
- [react-router](./modules/react_router)
19+
- [@react-router/dev](./modules/_react_router_dev)
20+
- [@react-router/node](./modules/_react_router_node)
21+
- [@react-router/cloudflare](./modules/_react_router_cloudflare)
22+
- [@react-router/serve](./modules/_react_router_serve)
23+
- [@react-router/fs-routes](./modules/_react_router_fs_routes)
4024

41-
React Router is developed and maintained by [Remix Software](https://remix.run) and many [amazing contributors](https://github.com/remix-run/react-router/graphs/contributors).
25+
## Previous Versions
4226

43-
[fetch-api]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
27+
- [v6](https://reactrouter.com/v6)
28+
- [v5](https://v5.reactrouter.com/)

Diff for: ‎packages/create-react-router/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# create-react-router
2-
31
Create a new React Router app.
42

53
```sh

Diff for: ‎packages/react-router-architect/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# @react-router/architect
2-
3-
Architect server request handler for React Router.
1+
[Architect](https://arc.codes) server request handler for React Router.
42

53
```bash
64
npm install @react-router/architect

Diff for: ‎packages/react-router-cloudflare/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# @react-router/cloudflare
2-
3-
Cloudflare platform abstractions for [React Router.](https://reactrouter.com)
1+
Cloudflare platform abstractions for React Router
42

53
```bash
64
npm install @react-router/cloudflare @cloudflare/workers-types

Diff for: ‎packages/react-router-dev/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# @react-router/dev
2-
3-
Dev tools and CLI for [React Router.](https://github.com/remix-run/react-router)
1+
Dev tools and CLI for React Router that enables framework features through bundler integration like server rendering, code splitting, HMR, etc.
42

53
```sh
64
npm install @react-router/dev

Diff for: ‎packages/react-router-dom/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
# React Router DOM
1+
This package simply re-exports everything from `react-router` to smooth the upgrade path for v6 applications. Once upgraded you can change all of your imports and remove it from your dependencies:
22

3-
The `react-router-dom` package is deprecated and only kept around for backwards-compatibility. It re-exports everything from the `react-router` package - you should convert your applications to import everything from `react-router` in v7 and beyond.
3+
```diff
4+
-import { Routes } from "react-router-dom"
5+
+import { Routes } from "react-router"
6+
```

Diff for: ‎packages/react-router-express/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# @react-router/express
2-
3-
[Express](https://expressjs.com) server request handler for [React Router.](https://github.com/remix-run/react-router)
1+
[Express](https://expressjs.com) server request handler for React Router.
42

53
```sh
64
npm install @react-router/express

Diff for: ‎packages/react-router-fs-routes/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# @react-router/fs-routes
2-
3-
File system routing conventions for [React Router](https://github.com/remix-run/react-router), for use within `routes.ts`.
1+
File system routing conventions for React Router
42

53
```sh
64
npm install @react-router/fs-routes

Diff for: ‎packages/react-router-node/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# @react-router/node
2-
3-
Node.js platform abstractions for [React Router.](https://github.com/remix-run/react-router)
1+
Node.js platform abstractions for React Router
42

53
```sh
64
npm install @react-router/node

Diff for: ‎packages/react-router-serve/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# @react-router/serve
2-
3-
Production application server for [React Router.](https://github.com/remix-run/react-router)
1+
Node.js application server for React Router
42

53
```sh
64
npm install @react-router/serve

Diff for: ‎packages/react-router/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1-
# React Router
1+
`react-router` is the primary package in the React Router project.
22

3-
The `react-router` package is the heart of [React Router](https://github.com/remix-run/react-router) and provides all the core functionality.
3+
## Installation
4+
5+
```sh
6+
npm i react-router
7+
```

Diff for: ‎packages/react-router/tsup.config.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,8 @@ const config = (enableDevWarnings: boolean) =>
4040
},
4141
]);
4242

43-
export default defineConfig([...config(false), ...config(true)]);
43+
export default defineConfig([
44+
// @ts-expect-error
45+
...config(false),
46+
...config(true),
47+
]);

0 commit comments

Comments
 (0)