Skip to content

Commit

Permalink
more readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
hpx7 committed Mar 23, 2021
1 parent 05f7221 commit dc8c539
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,20 +88,26 @@ The entry point for the application's backend logic lives in the root of the `se

### Internal state

The server side state representation.
The server side representation of a single state instance.

### Initialize
### Initialize method

Returns the initial internal state based on the user context and arguments.

### Mutation methods

Modifies internal state based on the user context and arguments. Returns a success or error result.

### getUserState
### getUserState method

Maps from the internal state to the user state based on the user context. This mapping allows privacy rules to be enforced so that the user only gets the data they should have access to.

### onTick method

Server ticks can be enabled by setting `tick: true` in `rtag.yml`.

This method is called at a regular interval in the server and has access to the internal state. It is used for background tasks that can update the state, e.g. physics simulations etc.

## Frontend

One of rtag's most powerful prototyping features is the generated debug app, which lets you interact with your application and test your backend logic without writing any frontend code. Furthurmore, rtag provides ways to incrementally add custom presentation logic as you become ready for it.
Expand Down

0 comments on commit dc8c539

Please sign in to comment.