Skip to content

Commit 501ae88

Browse files
committed
Rename to react-search-component and remove most Fair DO references
1 parent fdc9ef7 commit 501ae88

28 files changed

+840
-888
lines changed

CITATION.cff

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
cff-version: 1.2.0
22
message: If you use this software, please cite it using these metadata.
33
type: software
4-
title: '@kit-data-manager/react-fairdo-search'
5-
abstract: All-in-one component for rendering an elastic search UI for searching fair
6-
digital objects or anything else.
7-
version: 0.1.0
4+
title: '@kit-data-manager/react-search-component'
5+
abstract: All-in-one component for rendering an elastic search UI for searching anything.
6+
Built-in support for visualizing related items in a graph and resolving unique identifiers.
7+
version: 0.1.1
88
keywords:
99
- react
1010
- reactjs
@@ -36,5 +36,5 @@ contact:
3636
given-names: Christopher
3737
affiliation: Karlsruhe Institute of Technology (KIT)
3838
license: Apache-2.0
39-
url: https://kit-data-manager.github.io/react-fairdo-search/
40-
repository-code: https://github.com/kit-data-manager/react-fairdo-search
39+
url: https://kit-data-manager.github.io/react-search-component/
40+
repository-code: https://github.com/kit-data-manager/react-search-component

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
1-
# fairdo-elastic-search
1+
# react-search-component
22

3-
[![Static Badge](https://img.shields.io/badge/npm-red?logo=npm)](https://www.npmjs.com/package/@kit-data-manager/react-fairdo-search)
4-
[![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)
5-
![NPM Type Definitions](https://img.shields.io/npm/types/%40kit-data-manager%2Freact-fairdo-search)
3+
[![Static Badge](https://img.shields.io/badge/npm-red?logo=npm)](https://www.npmjs.com/package/@kit-data-manager/react-search-component)
4+
[![Node.js CI](https://github.com/kit-data-manager/react-search-component/actions/workflows/build.yml/badge.svg)](https://github.com/kit-data-manager/react-search-component/actions/workflows/build.yml)
5+
![NPM Type Definitions](https://img.shields.io/npm/types/%40kit-data-manager%2Freact-search-component)
66

77
All-in-one, highly configurable React component for rendering an elastic search UI based on the provided configuration. Includes
8-
an interactive graph of related records.
8+
an **interactive graph** of related records and **unique identifier resolving**.
9+
10+
> **Fair Digital Objects**\
11+
> This component includes some useful (optional) features for FAIR DOs
912
1013
This is an ESM Module intended for use in modern React applications. Make sure your bundler supports importing CSS files in JavaScript/TypeScript. Next.js is supported out of the box.
1114

1215
## Installation
1316

1417
```bash
15-
npm install @kit-data-manager/react-fairdo-search
18+
npm install @kit-data-manager/react-search-component
1619
```
1720

1821
## Docs
1922

20-
[Visit the Storybook](https://kit-data-manager.github.io/react-fairdo-search/?path=/docs/getting-started--docs) for examples and some documentation. For more documentation, consult the TypeScript typings.
23+
[Visit the Storybook](https://kit-data-manager.github.io/react-search-component/?path=/docs/getting-started--docs) for examples and some documentation. For more documentation, consult the TypeScript typings.
2124

2225
## Quick Start
2326

@@ -41,7 +44,7 @@ uses the `GenericResultView` with modified data:
4144

4245
```typescript jsx
4346
import { useMemo } from "react"
44-
import { GenericResultView, ResultViewProps } from "@kit-data-manager/react-fairdo-search"
47+
import { GenericResultView, ResultViewProps } from "@kit-data-manager/react-search-component"
4548

4649
export function MyResultView(props: ResultViewProps) {
4750
const mappedResult = useMemo(() => {
@@ -63,7 +66,7 @@ Styling is done using tailwind and css variables. Feel free to override these va
6366

6467
## Contributing
6568

66-
Feedback and issue reports are welcome, simply [create an issue](https://github.com/kit-data-manager/react-fairdo-search/issues/new) here on GitHub.
69+
Feedback and issue reports are welcome, simply [create an issue](https://github.com/kit-data-manager/react-search-component/issues/new) here on GitHub.
6770

6871
### Development
6972

codemeta.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
"affiliation": "Karlsruhe Institute of Technology (KIT)"
1919
}
2020
],
21-
"name": "@kit-data-manager/react-fairdo-search",
22-
"description": "All-in-one component for rendering an elastic search UI for searching fair digital objects or anything else.",
23-
"version": "0.1.0",
21+
"name": "@kit-data-manager/react-search-component",
22+
"description": "All-in-one component for rendering an elastic search UI for searching anything. Built-in support for visualizing related items in a graph and resolving unique identifiers.",
23+
"version": "0.1.1",
2424
"keywords": [
2525
"react",
2626
"reactjs",
@@ -54,8 +54,8 @@
5454
"license": [
5555
"https://spdx.org/licenses/Apache-2.0"
5656
],
57-
"softwareHelp": "https://kit-data-manager.github.io/react-fairdo-search/",
58-
"codeRepository": "https://github.com/kit-data-manager/react-fairdo-search",
59-
"buildInstructions": "https://kit-data-manager.github.io/react-fairdo-search/",
60-
"url": "https://kit-data-manager.github.io/react-fairdo-search/"
57+
"softwareHelp": "https://kit-data-manager.github.io/react-search-component/",
58+
"codeRepository": "https://github.com/kit-data-manager/react-search-component",
59+
"buildInstructions": "https://kit-data-manager.github.io/react-search-component/",
60+
"url": "https://kit-data-manager.github.io/react-search-component/"
6161
}

0 commit comments

Comments
 (0)