Skip to content

Commit 9cdf64e

Browse files
committed
Added documentation of parameters to README.md.
1 parent ea9c91e commit 9cdf64e

File tree

2 files changed

+45
-2
lines changed

2 files changed

+45
-2
lines changed

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,46 @@ of the page above.
6666

6767
Javascript bundle is wrapped into a UMD wrapper and should be safe
6868
to use with ECMAscript modules and AMD/Require.js. CSS bundle is
69-
using CSS modules and shouldn't be breaking CSS of your webpage.
69+
using CSS modules and shouldn't be breaking CSS of your webpage.
70+
71+
## Parameters
72+
73+
SequenceSearch component accepts a number of parameters. You pass them as html attributes
74+
in curly braces:
75+
76+
```
77+
<SequenceSearch databases={['mirbase']} onSubmit={function (query, databases) { console.log('hi!') }} />
78+
```
79+
80+
#### databases
81+
82+
Array of databases to search query sequence against. Currently you can choose from:
83+
84+
database |
85+
-------------|
86+
ena |
87+
greengenes |
88+
lncrnadb |
89+
mirbase |
90+
pdbe |
91+
pombase |
92+
rdp |
93+
refseq |
94+
rfam |
95+
rgd |
96+
sgd |
97+
snopy |
98+
srpdb |
99+
tair |
100+
tmrna-website|
101+
wormbase |
102+
103+
104+
#### onSubmit
105+
106+
A hook (your custom javascript function) to be executed, when user submits a sequence. This function can receive
107+
2 parameters:
108+
109+
* query - the query sequence, submitted by user
110+
* databases - array of databases
111+

src/services/routes.jsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
let server = 'https://rnacentral.org/cloud-sequence-search';
1+
// let server = 'https://rnacentral.org/cloud-sequence-search';
22
// let server = 'http://193.62.55.44:8002';
3+
let server = 'http://193.62.55.45';
34

45

56
module.exports = {

0 commit comments

Comments
 (0)