knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[README][s]: small tweaks to README (and a formatting fix in examples/catalog/README).

Browse Source
This commit is contained in:
Rufus Pollock
2021-03-07 23:15:14 +01:00
parent 58b0132055
commit fbb8193869
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -1,8 +1,8 @@
<h1 align="center"> <h1 align="center">
🌀 Portal.JS<br/> 🌀 Portal.JS<br/>
build a gateway to your data A gateway to your data
</h1> </h1>
🌀 `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.

4
examples/catalog/README.md
View File

@@ -21,7 +21,7 @@ Live DEMO: https://portal.datopian1.now.sh
- 👩‍💻 Developer friendly: built with familiar frontend tech Javascript, React etc - 👩‍💻 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. - 🔋 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. - 🎨 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. - 📝 Well documented: full set of documentation plus the documentation of NextJS and Apollo.
### For developers ### 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; 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 ```js
i18n: { i18n: {