Skip to content

Commit

Permalink
📝 add mermaid diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
Odonno committed May 22, 2023
1 parent 25d4fac commit 34fb43f
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,26 @@ A migration file represents a change in SurrealDB data. It can be a change in th

## Get started

```mermaid
stateDiagram-v2
scaffold : Scaffold a project
changeSchema : Change schema/event
createMigration: Create migration (data changes)
apply : Apply to your database
state fork_state <<fork>>
[*] --> scaffold
scaffold --> fork_state
fork_state --> changeSchema
fork_state --> createMigration
state join_state <<join>>
changeSchema --> join_state
createMigration --> join_state
join_state --> apply
apply --> fork_state
```

### 1. Scaffold

You can start a migration project by scaffolding a new project using the following command line:
Expand Down

0 comments on commit 34fb43f

Please sign in to comment.