Skip to content

Commit 03cecf4

Browse files
committed
update README.md
1 parent 87ebd28 commit 03cecf4

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
22
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
33

4-
name: Node.js CI
4+
name: Build
55

66
on:
77
push:

.github/workflows/deploy-github-pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Workflow name
2-
name: Build and Publish Storybook to GitHub Pages
2+
name: Publish Storybook
33

44
on:
55
# Event for the workflow to run on

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# fairdo-elastic-search
22

3+
[![Node.js CI](https://github.com/kit-data-manager/react-fairdo-search/actions/workflows/build.yml/badge.svg)](https://github.com/kit-data-manager/react-fairdo-search/actions/workflows/build.yml)
4+
5+
> ⚠️ This component is in active development. Consider it **not** ready for production.
6+
37
All-in-one React component for rendering an elastic search UI based on the provided configuration. Includes
48
an interactive graph of related records.
59

@@ -8,12 +12,12 @@ This is an ESM Module intended for use in modern React applications. Make sure y
812
## Installation
913

1014
```bash
11-
npm install ?
15+
npm install @kit-data-manager/react-fairdo-search
1216
```
1317

1418
## Docs
1519

16-
Refer to storybook and code
20+
[Visit the Storybook](https://kit-data-manager.github.io/react-fairdo-search/?path=/docs/getting-started--docs)
1721

1822
## Customization
1923

0 commit comments

Comments
 (0)