README.md in quilt_rails-1.13.0 vs README.md in quilt_rails-2.0.0

- old
+ new

@@ -21,11 +21,11 @@ - [Performance tracking a React app](#performance-tracking-a-react-app) - [API](#api) ## Server-side-rendering -🗒 This guide is focused on internal Shopify developers with access to [`dev`](https://github.com/Shopify/dev) and [@shopify/sewing-kit](https://github.com/Shopify/sewing-kit). A similar setup can be achieved using the [manual installation](./docs/manual-installation) , and following the [react-server-webpack-plugin](../../packages/react-server-webpack-plugin/README.md) guide. Apps not running on Shopify infrastructure should [disable server-side GraphQL queries](./docs/FAQ.md) to avoid scalability issue. +🗒 This guide is focused on internal Shopify developers with access to [`dev`](https://github.com/Shopify/dev) and [@shopify/sewing-kit](https://github.com/Shopify/sewing-kit). A similar setup can be achieved using the [manual installation](./docs/manual-installation.md) , and following the [react-server webpack plugin](../../packages/react-server/README.md#webpack-plugin) guide. Apps not running on Shopify infrastructure should [disable server-side GraphQL queries](./docs/FAQ.md) to avoid scalability issue. ### Quick start Using the magic of generators, we can spin up a basic app with a few console commands. @@ -34,22 +34,26 @@ With access to [`dev`](https://github.com/Shopify/dev), you can use `dev init` to scaffold out a Rails application. When prompted, choose `rails`. This will generate a basic Rails application scaffold. Alternatively, you can use [`rails new .`](https://guides.rubyonrails.org/command_line.html#rails-new) to do the same. -In either case, remove [`webpacker`](./docs/FAQ.md#i-run-into-webpacker-issue-while-setting-up-quilt_rails) before continuing. +In either case, remove [`webpacker`](./docs/FAQ.md#i-run-into-webpacker-issue-while-setting-up-quilt_rails) and [these files](./docs/FAQ.md#any-other-files-i-should-remove-before-running-generator) that any create conflict before continuing. #### Add Ruby dependencies `bundle add sewing_kit quilt_rails` This will install our ruby dependencies and update the project's gemfile. #### Generate app boilerplate -`rails generate quilt_rails:install` +`rails generate sewing_kit:install` +This will generate a package.json file with common sewing-kit script tasks, default lint, format configuration; a sewing-kit configuration file, and other project default configurations. + +`rails generate quilt:install` + This will install Node dependencies, provide a basic React app (in TypeScript), and mount the Quilt engine in `config/routes.rb`. Basic linting and format configurations are also generated. #### Try it out ```sh @@ -59,11 +63,11 @@ Will run the application, starting up both servers and compiling assets. ### Manual installation -Follow [this guide](./docs/manual-installation) on how to do manual setup without the generator. +Follow [this guide](./docs/manual-installation.md) on how to do manual setup without the generator. ### Advanced use #### Testing @@ -220,11 +224,11 @@ `useSerialized` can be used to implement [universal-providers](https://github.com/Shopify/quilt/tree/master/packages/react-universal-provider#what-is-a-universal-provider-), allowing application code to manage what is persisted between the server and client without adding any custom code to client or server entrypoints. We offer some for common use cases such as [CSRF](https://github.com/Shopify/quilt/tree/master/packages/react-csrf-universal-provider), [GraphQL](https://github.com/Shopify/quilt/tree/master/packages/react-graphql-universal-provider), [I18n](https://github.com/Shopify/quilt/tree/master/packages/react-i18n-universal-provider), and the [Shopify App Bridge](https://github.com/Shopify/quilt/tree/master/packages/react-app-bridge-universal-provider). #### Customizing the Node server -By default, sewing-kit bundles in [`@shopify/react-server-webpack-plugin`](../../packages/react-server-webpack-plugin/README.md) for `quilt_rails` applications to get apps up and running fast without needing to manually write any Node server code. +By default, sewing-kit bundles in [`@shopify/react-server/webpack-plugin`](../../packages/react-server/README.md#webpack-plugin) for `quilt_rails` applications to get apps up and running fast without needing to manually write any Node server code. If what it provides is not sufficient, a completely custom server can be defined by adding a `server.js` or `server.ts` file to the `app/ui` folder. The simplest way to customize the server is to export the object created by [`@shopify/react-server`](../../packages/react-server/README.md#node-usage)'s `createServer` call in `server.ts` file. ``` └── appeon @@ -278,14 +282,14 @@ ``` ## Performance tracking a React app To setup performance tracking with your React app with `quilt_rails`. -Follow details guide [here](./docs/performance-tracking). +Follow details guide [here](./docs/performance-tracking.md). ## API -Find all features this gem offer in this [API doc](./docs/api). +Find all features this gem offer in this [API doc](./docs/api.md). ## FAQ -Find your [here](./docs/FAQ). +Find your [here](./docs/FAQ.md).