readme

eea · Feb 22, 2024 · 40c86eb · 40c86eb
1 parent fe70f41
commit 40c86eb
Showing 1 changed file with 41 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -1,38 +1,43 @@
-# volto-addon-template
+# volto-doublerange-facet
 
-[![Releases](https://img.shields.io/github/v/release/eea/volto-addon-template)](https://github.com/eea/volto-addon-template/releases)
+[![Releases](https://img.shields.io/github/v/release/eea/volto-doublerange-facet)](https://github.com/eea/volto-doublerange-facet/releases)
 
-[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-addon-template%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-addon-template/job/master/display/redirect)
-[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-addon-template-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-addon-template-master)
-[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-addon-template-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-addon-template-master)
-[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-addon-template-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-addon-template-master)
-[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-addon-template-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-addon-template-master)
-
-[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-addon-template%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-addon-template/job/develop/display/redirect)
-[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-addon-template-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-addon-template-develop)
-[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-addon-template-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-addon-template-develop)
-[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-addon-template-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-addon-template-develop)
-[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-addon-template-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-addon-template-develop)
+[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-doublerange-facet%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-doublerange-facet/job/master/display/redirect)
+[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-master)
+[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-master)
+[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-master)
+[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-master)
 
+[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-doublerange-facet%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-doublerange-facet/job/develop/display/redirect)
+[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-develop)
+[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-develop)
+[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-develop)
+[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-develop)
 
 [Volto](https://github.com/plone/volto) add-on
 
 ## Features
 
-Demo GIF
+This addon let's you configure a double range facet in the Volto Search Block.
+
+This allows you to build a year range selector for instance.
+
+This facet requires to have the value indexed as a `FieldIndex` in the Plone backend.
+
+At this moment the values need to be indexes as strings in the Plone backend. We will be working on supporting also values indexed as ints in the backend.
 
 ## Getting started
 
-### Try volto-addon-template with Docker
+### Try volto-doublerange-facet with Docker
 
-      git clone https://github.com/eea/volto-addon-template.git
-      cd volto-addon-template
+      git clone https://github.com/eea/volto-doublerange-facet.git
+      cd volto-doublerange-facet
       make
       make start
 
 Go to http://localhost:3000
 
-### Add volto-addon-template to your Volto project
+### Add volto-doublerange-facet to your Volto project
 
 1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
 
@@ -42,25 +47,25 @@ Go to http://localhost:3000
 
 1. Start Volto frontend
 
-* If you already have a volto project, just update `package.json`:
+- If you already have a volto project, just update `package.json`:
 
-   ```JSON
-   "addons": [
-       "@eeacms/volto-addon-template"
-   ],
+  ```JSON
+  "addons": [
+      "@eeacms/volto-doublerange-facet"
+  ],
 
-   "dependencies": {
-       "@eeacms/volto-addon-template": "*"
-   }
-   ```
+  "dependencies": {
+      "@eeacms/volto-doublerange-facet": "*"
+  }
+  ```
 
-* If not, create one:
+- If not, create one:
 
-   ```
-   npm install -g yo @plone/generator-volto
-   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-addon-template
-   cd my-volto-project
-   ```
+  ```
+  npm install -g yo @plone/generator-volto
+  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-doublerange-facet
+  cd my-volto-project
+  ```
 
 1. Install new add-ons and restart Volto:
 
@@ -75,18 +80,18 @@ Go to http://localhost:3000
 
 ## Release
 
-See [RELEASE.md](https://github.com/eea/volto-addon-template/blob/master/RELEASE.md).
+See [RELEASE.md](https://github.com/eea/volto-doublerange-facet/blob/master/RELEASE.md).
 
 ## How to contribute
 
-See [DEVELOP.md](https://github.com/eea/volto-addon-template/blob/master/DEVELOP.md).
+See [DEVELOP.md](https://github.com/eea/volto-doublerange-facet/blob/master/DEVELOP.md).
 
 ## Copyright and license
 
 The Initial Owner of the Original Code is European Environment Agency (EEA).
 All Rights Reserved.
 
-See [LICENSE.md](https://github.com/eea/volto-addon-template/blob/master/LICENSE.md) for details.
+See [LICENSE.md](https://github.com/eea/volto-doublerange-facet/blob/master/LICENSE.md) for details.
 
 ## Funding