From fbb8193869e3091f389c463d14b32ea43a901cae Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sun, 7 Mar 2021 23:15:14 +0100 Subject: [PATCH] [README][s]: small tweaks to README (and a formatting fix in examples/catalog/README). --- README.md | 4 ++-- examples/catalog/README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 10a32396..4503e86b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

🌀 Portal.JS
-build a gateway to your data +A gateway to your data

-🌀 `Portal` is a framework for rapidly presenting data from a single dataset to rich catalogs. `portal` is built in Javascript and React on top of the popular [Next.js][] framework. +🌀 `Portal` is the data presentation framework. `Portal` can be used to showcase a single dataset or build full-scale data catalogs/portals. `Portal` is built in Javascript and React on top of the popular Next.js framework. diff --git a/examples/catalog/README.md b/examples/catalog/README.md index b4061096..f656f809 100644 --- a/examples/catalog/README.md +++ b/examples/catalog/README.md @@ -21,7 +21,7 @@ Live DEMO: https://portal.datopian1.now.sh - 👩‍💻 Developer friendly: built with familiar frontend tech Javascript, React etc - 🔋 Batteries included: Full set of portal components out of the box e.g. catalog search, dataset showcase, blog etc. - 🎨 Easy to theme and customize: installable themes, use standard CSS and React+CSS tooling. Add new routes quickly. -- 🧱E Extensible: quickly extend and develop/import your own React components +- 🧱 Extensible: quickly extend and develop/import your own React components - 📝 Well documented: full set of documentation plus the documentation of NextJS and Apollo. ### For developers @@ -106,7 +106,7 @@ For development/debugging purposes, we suggest installing the Chrome extension - Portal.js is configured by default to support both `English` and `French` subpath for language translation. But for subsequent users, this following steps can be used to configure i18n for other languages; -1. Update ` next.config.js`, to add more languages to the i18n locales +1. Update `next.config.js`, to add more languages to the i18n locales ```js i18n: {