Skip to content

Commit 3f6d1e1

Browse files
committed
docs: change README of fresh example
1 parent 197fa09 commit 3f6d1e1

1 file changed

Lines changed: 36 additions & 11 deletions

File tree

examples/fresh/README.md

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,42 @@
1-
# Fresh project
1+
Fedify–Fresh integration example
2+
===================================
23

3-
Your new Fresh project is ready to go. You can follow the Fresh "Getting
4-
Started" guide here: https://fresh.deno.dev/docs/getting-started
4+
This is a simple example of how to integrate Fedify into an [Fresh]
5+
application.
56

6-
### Usage
7+
[Fresh]: https://fresh.deno.dev/
78

8-
Make sure to install Deno:
9-
https://docs.deno.com/runtime/getting_started/installation
109

11-
Then start the project in development mode:
10+
Running the example
11+
-------------------
1212

13-
```
14-
deno task dev
15-
```
13+
1. Clone the repository:
1614

17-
This will watch the project directory and restart as necessary.
15+
~~~~ sh
16+
git clone https://github.com/fedify-dev/fedify.git
17+
~~~~
18+
19+
2. Build pacakges
20+
21+
~~~~ sh
22+
cd fedify
23+
deno task build
24+
~~~~
25+
26+
3. Move to example folder
27+
28+
~~~~ sh
29+
cd ../../examples/fresh
30+
~~~~
31+
32+
4. Start the server:
33+
34+
~~~~ sh
35+
deno task dev
36+
~~~~
37+
38+
5. Check NodeInfo of server
39+
40+
~~~~ sh
41+
fedify nodeinfo https://localhost:5173
42+
~~~~

0 commit comments

Comments
 (0)