Skip to content

Commit 1e35b29

Browse files
author
Piotr
committed
some readme updates
1 parent fa45f76 commit 1e35b29

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,26 @@
1717

1818
### Latest version: 0.14.1 (20 February 2024) - [Read announcement](https://logdy.dev/blog/post/logdy-new-version-announcement-v014)
1919

20-
Logdy is a single-binary that you add to your PATH so it's available just like any other tool: grep, awk, sed, jq. **No installations, no deployments, no compilations**. It works locally, so it's also secure. [Read more](https://logdy.dev/docs/what-is-logdy).
20+
Logdy is a lightweight, single-binary log viewer that works just like `grep`, `awk`, `sed`, or `jq`. Simply add it to your PATH—no installation, deployment, or compilation required. It runs entirely locally, ensuring security and privacy. [Read more](https://logdy.dev/docs/what-is-logdy).
21+
22+
### Key features
23+
* Zero-dependency single binary
24+
* Embedded Web UI
25+
* Real-time log viewing and filtering
26+
* Secure local operation
27+
* Multiple input modes (files, stdin, sockets, REST API)
28+
* Custom parsers and columns with TypeScript support (code editor with types support)
29+
* Go library integration
2130

2231
### Standalone use
2332
```bash
2433
# Use with any shell command
2534
$ tail -f file.log | logdy
26-
INFO[2024-02...] WebUI started, visit http://localhost:8080 port=8080
35+
WebUI started, visit http://localhost:8080
2736

2837
# Read log files
2938
$ logdy follow app-out.log --full-read
30-
INFO[2024-02...] WebUI started, visit http://localhost:8080 port=8080
39+
WebUI started, visit http://localhost:8080
3140
```
3241
More use [modes in the docs.](https://logdy.dev/docs/explanation/command-modes)
3342

@@ -42,8 +51,11 @@ func main(){
4251
ServerIp: "127.0.0.1",
4352
ServerPort: "8080",
4453
}, nil)
45-
logdyLogger.LogString("Log message")
46-
<-context.Background().Done()
54+
55+
// app code...
56+
57+
logdyLogger.LogString("This is a message")
58+
logdyLogger.Log(logdy.Fields{"msg": "supports structured logs too", "url": "some url here"})
4759
}
4860
```
4961
Check [docs](https://logdy.dev/docs/golang-logs-viewer) or [example app](https://github.com/logdyhq/logdy-core/blob/main/example-app/main.go).
@@ -54,36 +66,36 @@ Visit [demo.logdy.dev](https://demo.logdy.dev)
5466

5567
![autogenerate](https://github.com/logdyhq/logdy-core/assets/1653294/bfe09fa8-bbba-46fa-b54d-503f796c7b57)
5668

57-
Visit [logdy.dev](http://logdy.dev) for more info and detalied documentation.
69+
Visit [logdy.dev](http://logdy.dev) for more info and detailed documentation.
5870

59-
##### Project status: Beta version, new features added actively.
71+
##### Project status: New features added actively.
6072

61-
Logdy is under heavy development and a lot of features is yet to be added. A feedback is welcome from early adopters. Feel free to post [Issues](https://github.com/logdyhq/logdy-core/issues), [Pull Requests](https://github.com/logdyhq/logdy-core/pulls) and contribute in the [Discussions](https://github.com/logdyhq/logdy-core/discussions). Stay tuned for updates, visit [Logdy Blog](https://logdy.dev/blog).
73+
Logdy is in active development, with new features being added regularly. Feedback is welcome from early adopters. Feel free to post [Issues](https://github.com/logdyhq/logdy-core/issues), [Pull Requests](https://github.com/logdyhq/logdy-core/pulls) and contribute in the [Discussions](https://github.com/logdyhq/logdy-core/discussions). Stay tuned for updates, visit [Logdy Blog](https://logdy.dev/blog).
6274

6375
## Install using script
6476
The command below will download the latest release and add the executable to your system's PATH. You can also use it to update Logdy.
6577

6678
```bash
67-
$ curl https://logdy.dev/install.sh | sh
79+
curl https://logdy.dev/install.sh | sh
6880
```
6981

7082
## Install with Homebrew (MacOS)
7183
On MacOS you can use homebrew to install Logdy.
7284

7385
```bash
74-
$ brew install logdy
86+
brew install logdy
7587
```
7688

7789
## Download precompiled binary
7890

79-
Naviage to [releases](https://github.com/logdyhq/logdy-core/releases) Github page and download the latest release for your architecture.
91+
Navigate to [releases](https://github.com/logdyhq/logdy-core/releases) Github page and download the latest release for your architecture.
8092

8193
```bash
8294
wget https://github.com/logdyhq/logdy-core/releases/download/v0.14.1/logdy_linux_amd64;
8395
mv logdy_linux_amd64 logdy;
8496
chmod +x logdy;
8597
```
86-
In addition you can [add the binary to your PATH](https://logdy.dev/docs/how-tos#how-to-add-logdy-to-path) for easier access.
98+
Additionally, you can [add the binary to your PATH](https://logdy.dev/docs/how-tos#how-to-add-logdy-to-path) for easier access.
8799
## Quick start
88100
Whatever the below command will produce to the output, will be forwarded to a Web UI.
89101
```bash
@@ -99,7 +111,7 @@ There are multiple other ways you can run Logdy, check the [docs](https://logdy.
99111

100112
## Install Go library
101113
```bash
102-
$ go get -u github.com/logdyhq/logdy-core/logdy
114+
go get -u github.com/logdyhq/logdy-core/logdy
103115
```
104116
[Read more](https://logdy.dev/docs/golang-logs-viewer) about how to use Logdy embedded into your Go app.
105117

0 commit comments

Comments
 (0)