From 844ea9ea7293e2f9ab3c429f8e7f99829fc7d5d4 Mon Sep 17 00:00:00 2001 From: Aleksandr Gumroian Date: Fri, 25 Feb 2022 15:00:26 +0100 Subject: [PATCH] Improve docs introduction section --- docs/forisjs-npm.svg | 4 ++++ docs/intro.md | 6 ------ docs/introduction.md | 37 +++++++++++++++++++++++++++++++++++++ styleguide.config.js | 4 ++-- 4 files changed, 43 insertions(+), 8 deletions(-) create mode 100644 docs/forisjs-npm.svg delete mode 100644 docs/intro.md create mode 100644 docs/introduction.md diff --git a/docs/forisjs-npm.svg b/docs/forisjs-npm.svg new file mode 100644 index 0000000..8ebd3d8 --- /dev/null +++ b/docs/forisjs-npm.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index 4637cbc..0000000 --- a/docs/intro.md +++ /dev/null @@ -1,6 +0,0 @@ -Foris JS library is set of components and utils for Foris JS application and -plugins. - -Please notice that all of these components or utils are used in reForis and -plugins. If you like to study by example I would recommend to full-text search -these repos. diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 0000000..767327f --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,37 @@ +Welcome! This is the official documentation for Foris JS. + +## What Foris JS is + +Foris JS library is a set of components and utils for reForis application and +plugins. + +Please notice that all of these components or utils are used in reForis and +plugins. If you want to study them by example, I recommend you to full-text +search those repositories. + +# Installation + +## Prerequisites + +Please make sure that [Node.js](https://nodejs.org/en/) is installed on your +system. + +The current Long Term Support (LTS) release is an ideal starting point, see +[here](https://github.com/nodejs/Release#release-schedule). + +## Installation + +To install the latest release: + +```plain +npm install foris +``` + +To install a specific version: + +```plain +npm install foris@version +``` + +Check +on diff --git a/styleguide.config.js b/styleguide.config.js index 295c93a..83ca76f 100644 --- a/styleguide.config.js +++ b/styleguide.config.js @@ -11,8 +11,8 @@ module.exports = { title: "Foris JS docs", sections: [ { - name: "Foris JS", - content: "docs/intro.md", + name: "Introduction", + content: "docs/introduction.md", }, { name: "Development (Linking)",