Skip to content

Commit 02022db

Browse files
committed
Update instructions
1 parent 2330576 commit 02022db

File tree

1 file changed

+59
-37
lines changed

1 file changed

+59
-37
lines changed

README.md

Lines changed: 59 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
11
# RNAcentral sequence search embed
22

3-
This is an embeddable component that you can include into
4-
your website to add a non-coding RNA sequence search.
3+
This is an embeddable component that you can include into your website to add a non-coding RNA sequence search.
54

6-
The component sends search requests to EBI-backed API, run on
7-
EBI cloud infrastructure.
5+
The component sends search requests to EBI-backed API, run on EBI cloud infrastructure.
86

9-
It searches against RNAcentral databases (or their arbitrary subset)
10-
with NHMMER and also adds text search functionality, backed by EBI
11-
Lucene text search plugin.
7+
It searches against RNAcentral databases (or their arbitrary subset) with NHMMER, CMSCAN and also adds text search
8+
functionality, backed by EBI Lucene text search plugin.
129

13-
This plugin is written in React/Redux and makes use of Zurb
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.
10+
This plugin is written in React/Redux and makes use of Zurb Foundation-based EBI theme. It is bundled as a Web
11+
Component, so it should not clash with your website's javascript or CSS.
1612

1713
## Installation
1814

19-
Install this package with npm or download it directly from Github.
20-
21-
`npm install @rnacentral/rnacentral-sequence-search-embed`
22-
23-
or
15+
Download this package directly from Github.
2416

2517
`git clone https://github.com/RNAcentral/rnacentral-sequence-search-embed.git`
2618

27-
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:
19+
Now you can add the component's javascript bundle (it contains all the styles and fonts) to your web page either
20+
directly or through an import with Webpack:
3021

3122
`<script type="text/javascript" src="/rnacentral-sequence-search-embed/dist/RNAcentral-sequence-search.js"></script>`
3223

3324
To use it just insert an html tag somewhere in your html:
3425

3526
```
36-
<rnacentral-sequence-search databases='["mirbase"]' />
27+
<rnacentral-sequence-search databases='["miRBase"]' />
28+
```
29+
30+
To show some examples and/or enable the Rfam search, use:
31+
32+
```
33+
<rnacentral-sequence-search
34+
databases='["miRBase"]'
35+
examples='[
36+
{"description": "miRNA hsa-let-7a-1", "urs": "URS000004F5D8", "sequence": "CUAUACAAUCUACUGUCUUUC"},
37+
]
38+
rfam="true"
39+
/>
3740
```
3841

3942
For a minimal example, see [index.html](./index.html).
@@ -48,24 +51,43 @@ and their values are strings (this is a requirement of Web Components):
4851

4952
Array of databases to search query sequence against. Currently you can choose from:
5053

51-
database |
52-
-------------|
53-
ena |
54-
greengenes |
55-
lncrnadb |
56-
mirbase |
57-
pdbe |
58-
pombase |
59-
rdp |
60-
refseq |
61-
rfam |
62-
rgd |
63-
sgd |
64-
snopy |
65-
srpdb |
66-
tair |
67-
tmrna-website|
68-
wormbase |
54+
database |
55+
------------------|
56+
dictybase |
57+
ena |
58+
ensembl |
59+
ensembl_fungi |
60+
ensembl_metazoa |
61+
ensembl_plants |
62+
ensembl_protists |
63+
flybase |
64+
gencode |
65+
greengenes |
66+
gtrnadb |
67+
hgnc |
68+
lncbase |
69+
lncbook |
70+
lncipedia |
71+
lncrnadb |
72+
mgi |
73+
mirbase |
74+
modomics |
75+
noncode |
76+
pdbe |
77+
pombase |
78+
rdp |
79+
refseq |
80+
rfam |
81+
rgd |
82+
sgd |
83+
silva |
84+
snopy |
85+
srpdb |
86+
tair |
87+
tarbase |
88+
tmrna_web |
89+
wormbase |
90+
zwd |
6991

7092
## Developer details
7193

0 commit comments

Comments
 (0)