Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rikukissa committed Feb 3, 2025
1 parent 61e8100 commit d338f77
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/client/src/v2-events/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ Client for managing custom events.

We will be iterating over the structure during the project. Treat it as a starting point. Many times the important thing is to have any structure.

## Route structure

By default, Events V2 is accessible via the /v2 route, allowing the application’s normal operations to continue alongside its development. When Events V2 needs to be deployed to a live environment as the primary event type, the environment variable V2_EVENTS=true can be set in the country config package. This hides the old event views completely and replaces them with Events V2. Once Events V2 is officially released, it will become the default event view.

## Development practices

- Do not import components outside v2-events. If you need a component, copy it in and refactor it.
Expand Down

0 comments on commit d338f77

Please sign in to comment.