Skip to content

Commit d05d659

Browse files
committed
update README.md
1 parent c361b82 commit d05d659

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

+27-12
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,33 @@
1-
# XTrace
1+
# X-Trace
22

3-
To start your Phoenix server:
3+
A web tool for easy to use recon_trace
44

5-
* Run `mix setup` to install and setup dependencies
6-
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
5+
[Video Demo](https://twitter.com/kevin52069370/status/1752594271855894872)
76

8-
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
7+
## Usage
98

10-
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
9+
Download cli from [Releases](https://github.com/feng19/x_trace/releases)
1110

12-
## Learn more
11+
To start your server:
1312

14-
* Official website: https://www.phoenixframework.org/
15-
* Guides: https://hexdocs.pm/phoenix/overview.html
16-
* Docs: https://hexdocs.pm/phoenix
17-
* Forum: https://elixirforum.com/c/phoenix-forum
18-
* Source: https://github.com/phoenixframework/phoenix
13+
* Run `./xtrace_xxx` to start the endpoint
14+
* Now you can visit [`localhost:4000`](http://localhost:4000) from your browser
15+
16+
Or download desktop application from here: [Releases](https://github.com/feng19/x_trace_desktop/releases)
17+
18+
## Build
19+
20+
You must have the following installed and in your PATH:
21+
22+
- Erlang -- erl
23+
- Elixir -- mix
24+
- Zig (0.11.0) -- zig
25+
- XZ -- xz
26+
- 7z -- 7z (For Windows Targets)
27+
28+
To start your server:
29+
30+
* Run `mix setup` to install and setup dependencies
31+
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
32+
33+
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.

0 commit comments

Comments
 (0)