Skip to content

Commit 2eda968

Browse files
committed
add install instruction; remove discord link
1 parent 53cc32a commit 2eda968

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ overwhelmed by the great number of code snippets as the projects grow.
88
<div align="center"><h3><a href="https://codepod.io" target="_blank"> homepage</a> |
99
<a href="https://codepod.io/docs/manual/" target="_blank">manual</a> |
1010
<a href="https://app.codepod.io" target="_blank">try online</a>
11-
</h3> <a href="https://discord.gg/W4B4gQdZZS"><img src="https://dcbadge.vercel.app/api/server/W4B4gQdZZS?style=flat" /></a>
11+
</h3>
12+
<!-- <a href="https://discord.gg/W4B4gQdZZS"><img src="https://dcbadge.vercel.app/api/server/W4B4gQdZZS?style=flat" /></a> -->
1213
</div>
1314

1415
![screenshot](./screenshot-canvas.png)
@@ -21,7 +22,32 @@ Thanks to our community, we now have CodePod showcases ranging from analytical g
2122
- [image operations using skimage](https://user-images.githubusercontent.com/44469195/239033643-decbd7ae-29bb-44b9-af33-d4cb7c2bce46.png)
2223
- [tel-siRNA sequence detector](https://app.codepod.io/repo/b94n7n00a9395xwhv1o8)
2324

24-
# Run CodePod Locally
25+
# Install
26+
27+
You can install codepod CLI app with npm::
28+
29+
```
30+
> npm install -g codepod
31+
> codepod --version
32+
# 0.0.7
33+
```
34+
35+
You can use it like this:
36+
37+
```
38+
> codepod /path/to/repo
39+
# ... 🚀 Server ready at http://localhost:4001
40+
```
41+
42+
Open this URL in your browser to see the app. The files will be saved to the directory `/path/to/repo/.codepod/yjs.[bin|json]`.
43+
44+
Update the app:
45+
46+
```
47+
> npm update -g codepod
48+
```
49+
50+
# Develop
2551

2652
Open two terminals. On one:
2753

0 commit comments

Comments
 (0)