@juliocesar-io/nano-protein-viewer-react 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -2
- package/package.json +1 -1
- /package/dist/{index → index.cjs} +0 -0
- /package/dist/{index.esm → index.esm.js} +0 -0
package/README.md
CHANGED
|
@@ -6,7 +6,29 @@ This project brings the Mol\*-powered molecular visualization experience to the
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @juliocesar-io/nano-protein-viewer-react
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Peer deps: `react`, `react-dom`, `molstar`.
|
|
16
|
+
|
|
17
|
+
## Use in your app
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import { NanoProteinViewer, StructureUrl } from '@juliocesar-io/nano-protein-viewer-react';
|
|
21
|
+
|
|
22
|
+
const structures: StructureUrl[] = [
|
|
23
|
+
{ name: '1CRN', url: 'https://files.rcsb.org/download/1CRN.pdb', format: 'pdb' }
|
|
24
|
+
];
|
|
25
|
+
|
|
26
|
+
export default function App() {
|
|
27
|
+
return <NanoProteinViewer structureUrls={structures} />;
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Local deveploment
|
|
10
32
|
|
|
11
33
|
**Install dependencies**
|
|
12
34
|
|
|
@@ -26,7 +48,7 @@ You can define your own logic from a list of structures in src/App.tsx:
|
|
|
26
48
|
|
|
27
49
|
|
|
28
50
|
```ts
|
|
29
|
-
import type { StructureUrl } from '@
|
|
51
|
+
import type { StructureUrl } from '@juliocesar-io/nano-protein-viewer-react';
|
|
30
52
|
|
|
31
53
|
const exampleUrls: StructureUrl[] = [
|
|
32
54
|
{
|
package/package.json
CHANGED
|
File without changes
|
|
File without changes
|