Skip to content

Commit 830014f

Browse files
committed
Updated obsolete pieces of documentation.
1 parent 67428e3 commit 830014f

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ with NHMMER and also adds text search functionality, backed by EBI
1111
Lucene text search plugin.
1212

1313
This plugin is written in React/Redux and makes use of Zurb
14-
Foundation-based EBI theme. It is bundled with CSS modules and
15-
UMD wrapper and packaged with Webpack, so it should not clash with
16-
your website's javascript or CSS.
14+
Foundation-based EBI theme. It is bundled as a Web Component, so it
15+
should not clash with your website's javascript or CSS.
1716

1817
## Installation
1918

@@ -26,24 +25,25 @@ or
2625
`git clone https://github.com/RNAcentral/rnacentral-sequence-search-embed.git`
2726

2827

29-
Now you can add the javascript bundle and css bundle to your web page either directly or through
30-
an import with Webpack or native ECMAscript modules and CSS modules.
28+
Now you can add the component's javascript bundle (it contains all the styles and fonts)
29+
to your web page either directly or through an import with Webpack:
3130

32-
For a minimal example, see [index.html](./index.html).
33-
34-
Javascript bundle is wrapped into a UMD wrapper and should be safe
35-
to use with ECMAscript modules and AMD/Require.js. CSS bundle is
36-
using CSS modules and shouldn't be breaking CSS of your webpage.
37-
38-
## Parameters
31+
`<script type="text/javascript" src="/rnacentral-sequence-search-embed/dist/RNAcentral-sequence-search.js"></script>`
3932

40-
SequenceSearch component accepts a number of parameters. You pass them as html attributes
41-
in curly braces:
33+
To use it just insert an html tag somewhere in your html:
4234

4335
```
4436
<rnacentral-sequence-search databases='["mirbase"]' />
4537
```
4638

39+
For a minimal example, see [index.html](./index.html).
40+
41+
42+
## Attributes/parameters
43+
44+
Sequence search component accepts a number of attributes. You pass them as html attributes
45+
and their values are strings (this is a requirement of Web Components):
46+
4747
#### databases
4848

4949
Array of databases to search query sequence against. Currently you can choose from:
@@ -75,7 +75,9 @@ wormbase |
7575

7676
2. `npm run serve` to start a server on http://localhost:8080/
7777

78-
3. `npm run build` to generate a new distribution.
78+
3. `npm run clean` to clean the dist folder of old assets
79+
80+
4. `npm run build` to generate a new distribution.
7981

8082
### Notes
8183

0 commit comments

Comments
 (0)