Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
irealva authored Dec 7, 2021
1 parent 6d4a67a commit 1d71f1d
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# GitBub Blocks Examples

The Composable Github app depends on a set of "blocks" that handle how to render files and folders. This repo contains a set of example blocks that can serve as inspiration for you to create your own.
The [GitHub Blocks](https://github.com/githubnext/blocks) app depends on a set of "blocks" that handle how to render files and folders. This repo contains a set of example blocks that can serve as inspiration for you to create your own.

## Example blocks

Blocks come in two types: file blocks and folder blocks.

All blocks require an object within [`package.json`](https://github.com/githubnext/composable-github-example-blocks/blob/main/package.json#L20) to describe their intended use. For example:
All blocks require an object within [`package.json`](https://github.com/githubnext/blocks-examples/blob/main/package.json#L20) to describe their intended use. For example:

```json
{
Expand All @@ -24,12 +24,11 @@ All blocks require an object within [`package.json`](https://github.com/githubne
| Block name | Description | Supported extensions |
| ---------- | ---------------------------- | -------------------- |
| Code | Simple block for code | all extensions |
| 3D Files | 3D model block with Three.js | obj, fbx, gltf, glb |
| 3D Files | 3D model block with Three.js | gltf, glb |
| Css | View selectors in a css file | css |
| Excalidraw | A drawing/whiteboard block | excalidraw |
| Flat | A block for flat data files | csv, json |
| Iframe | Render any html iframe | iframe |
| Chart | A vega chart block | chart |
| Html | Render html | html |

### Folder blocks

Expand Down

0 comments on commit 1d71f1d

Please sign in to comment.