Skip to content

Commit

Permalink
Update ReadME for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
bmatto committed Oct 30, 2024
1 parent d321f6f commit a69b381
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion examples/getting-started-project-theme/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Getting Started Example

The getting started example within this directory covers a variety of key features/components of working with CMS React within a HubSpot website. This guide outlines the specifics of using CMS React primitives such as Modules, Fields, and Islands, as well as integrating third-party dependencies, styling, assets, and setting up local development tooling for your project.
This example is similar to the "getting-started" example, but demonstrates how to use CMS React within a Project Theme. Project Themes allow you to build and deploy themes using the Projects framework, which enables powerful new capabilities like:

- Using CMS React building blocks (Modules, Fields, Islands) directly within your theme
- Leveraging project-level dependencies and configuration
- Leveraging project build and deploy capabilities
- Better organization of theme assets and components

The example shows how to structure a Project Theme, integrate React components, and take advantage of these new features while building a fully functional theme.

## Setup

Expand Down

0 comments on commit a69b381

Please sign in to comment.