Skip to content

Commit 4c9265a

Browse files
committed
Updates README
1 parent 2b5500e commit 4c9265a

File tree

4 files changed

+232
-162
lines changed

4 files changed

+232
-162
lines changed

.yarn/install-state.gz

35.9 KB
Binary file not shown.

.yarnrc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
nodeLinker: node-modules

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Corcho (/ˈkoɾt͡ʃo/) is a tool that creates and sync web slideshows using the contents of a Figma file. You can then use GitHub Pages to host your slideshow on the web and have it automatically updated using GitHub Actions.
44

5-
## How to run this thing
5+
## How to run Corcho
66

77
1. Create a file in Figma and your slides as frames.
88
2. Create a non-expiring [Figma personal access token](https://help.figma.com/hc/en-us/articles/8085703771159-Manage-personal-access-tokens).
@@ -45,9 +45,7 @@ on:
4545
4. Run the project with `yarn start` or `npm run start`
4646
5. Open the `index.html` file in your browser using a local server.
4747

48-
---
49-
50-
### Shortcuts
48+
## Shortcuts
5149

5250
| Key | Action |
5351
| --------------------- | ----------------- |
@@ -69,8 +67,6 @@ on:
6967
| `Enter` | Select page |
7068
| `Esc` | Close navigation |
7169

72-
---
73-
7470
## Example
7571

7672
- [Figma file](https://www.figma.com/file/pCi2wnm9y4HsYNANvXRiGc/Corcho)

0 commit comments

Comments
 (0)