diff --git a/README.md b/README.md index 03d155f..07220ff 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,23 @@ Replica

-# Replica: An Open-Source Prototyping Tool +# Replica: An open-source prototyping tool -*Created by GitHub Design* +Replica helps your entire product team prototype with your design system. It's an open-source tool that uses AI to turn ideas into interactive prototypes, guided by your components, patterns, and documentation. -Replica helps your whole product team prototype with your design system. It's an open-source tool that uses AI to turn ideas into interactive prototypes, guided by your components, patterns, and documentation. +Designers create and approve the guidance. People across design, product, and engineering can then describe a change in the GitHub Copilot app, try the result, and refine it with their team and users. -Designers shape and approve the guidance. People across design, product, and engineering can then describe a change in the GitHub Copilot app, try the result, and refine it with their team and users. - -Use those prototypes to test assumptions and work through questions together. Your team still decides what should ship and how to build it. +Use prototypes to test assumptions and work through questions together. Your team still decides what should ship and how to build it. Replica is MIT-licensed. You can prototype locally without a server or set up Replica Hub for hosting and commenting. ## Try Replica -See how Replica works before you set anything up. +Explore Replica before setting anything up. [Watch the Replica introduction on YouTube](https://www.youtube.com/watch?v=J2Z28CwIfsA) -Ready to try it with your own product? [Set up Replica for your team](#set-up-replica-for-your-team). - -## Set up Replica for your team +## Get started with Replica Replica has four parts: @@ -33,11 +29,11 @@ Replica has four parts: | **Replica Hub (optional)** | Hosts published prototypes so your team can try them and leave comments. | | **GitHub build action** | Builds prototypes for publishing to Hub. It is not needed for local prototyping. | -**Making prototypes?** Follow [Get started with Replica](docs/getting-started.md) to install the GitHub Copilot app, add your team's prototyping repository, install the canvas, and create your first prototype. It also covers connecting to Hub, publishing, sharing and commenting, and adding controls. +**Ready to make prototypes?** Follow [Get started with Replica](docs/getting-started.md) to install the GitHub Copilot app, add your team's prototyping repository, install the canvas, and create your first prototype. It also covers connecting to Hub, publishing, sharing and commenting, and adding controls. **Setting up Replica for your organization?** Follow [environment setup](docs/prototype-environment.md) to create your team's prototyping repository, add your design system and guidance, and deploy Hub. Your organization deploys and runs Hub on its own infrastructure. GitHub doesn't host it. -**How did setup go?** [Share your setup feedback](https://survey.alchemer.com/s3/9055055/Replica-feedback). It helps us make Replica easier to start. +**How did setup go?** [Share your feedback](https://survey.alchemer.com/s3/9055055/Replica-feedback). It helps us make Replica easier to start. ### Copilot requirements @@ -58,7 +54,7 @@ See [Hub analytics](hub/docs/analytics.md), [security](hub/docs/security.md), an Replica is under active development and maintained by GitHub staff. See [Support](SUPPORT.md) for help and questions, or [report a bug](https://github.com/github/replica/issues). Support is limited to the resources described in the support policy. -Tried Replica? [Tell us how it went](https://survey.alchemer.com/s3/9055055/Replica-feedback). +Tried Replica? [Share your experience](https://survey.alchemer.com/s3/9055055/Replica-feedback). Contributions are welcome. Read [Contributing](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md) before participating. @@ -67,3 +63,7 @@ Contributions are welcome. Read [Contributing](CONTRIBUTING.md) and the [Code of ## License This project is licensed under the MIT open source license. See [LICENSE](LICENSE) for the full terms. Bundled fonts use the SIL Open Font License; see [NOTICE](NOTICE.md). + +--- + +_Created by GitHub Design and Microsoft CoreAI Design_