diff --git a/README.md b/README.md index 6ffbd61d..cbc91573 100644 --- a/README.md +++ b/README.md @@ -42,27 +42,32 @@ Install `yarn`. Create a demo portal (for a single dataset): -``` -# note: we have to use `yarn` until #529 is resolved ... -yarn create next-app -e https://github.com/datopian/portal.js/tree/main/examples/dataset-frictionless +```bash +npx create next-app -e https://github.com/datopian/portal.js/tree/main/examples/dataset-frictionless # choose a name for your portal when prompted e.g. your-portal or go with default my-app # then run it cd your-portal -yarn dev +yarn #install packages +yarn dev #start app in dev mode ``` + You should see the demo portal running. + You can try it out with other Frictionless datasets. ### Check out more of the examples -Check out more of the examples on how to create a portal for your dataset or datasets in the [`examples` directory](./examples) e.g. +The [`examples` directory](./examples) is regularly updated with different portal examples. * [A portal for a single Frictionless dataset](./examples/dataset-frictionless) * [A portal with a CKAN backend](./examples/catalog) +## Deploying portal build to github pages +* [Deploying single frictionless dataset to Github]("./scripts/README.md") + --- # Appendix: What happened to Recline? diff --git a/assets/demo.gif b/assets/demo.gif new file mode 100644 index 00000000..27bdc384 Binary files /dev/null and b/assets/demo.gif differ