From b7af00ae75b59cc3706be271d960d8f3435f5d5c Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Thu, 27 May 2021 04:46:37 +0100 Subject: Improve documentation through advanced AI --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index dfe351c..a3e3f30 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ DTail [![License](https://img.shields.io/github/license/mimecast/dtail)](https://www.apache.org/licenses/LICENSE-2.0.html) [![Go Report Card](https://goreportcard.com/badge/github.com/mimecast/dtail)](https://goreportcard.com/report/github.com/mimecast/dtail) [![Hits-of-Code](https://hitsofcode.com/github/mimecast/dtail)](https://www.vbrandl.net/post/2019-05-03_hits-of-code/) ![GitHub issues](https://img.shields.io/github/issues/mimecast/dtail) ![GitHub forks](https://img.shields.io/github/forks/mimecast/dtail) ![GitHub stars](https://img.shields.io/github/stars/mimecast/dtail) -DTail (a distributed tail program) is a DevOps tool for engineers programmed in Google Go for following (tailing), catting and grepping (including gzip and zstd decompression support) log files on many machines concurrently. An advanced feature of DTail is to execute distributed mapreduce aggregations across many machines. +DTail (a distributed tail program) is a DevOps tool for engineers programmed in Google Go for following (tailing), catting and grepping (including gzip and zstd decompression support) log files on many machines concurrently. An advanced feature of DTail is to execute distributed MapReduce aggregations across many devices. -For secure authorization and transport encryption the SSH protocol is used. Furthermore, DTail respects the UNIX file system permission model (traditional on all Linux/UNIX variants and also ACLs on Linux based operating systems). +For secure authorization and transport encryption, the SSH protocol is used. Furthermore, DTail respects the UNIX file system permission model (traditional on all Linux/UNIX variants and also ACLs on Linux based operating systems). -The DTail binary operate in either client or in server mode. The DTail server must be installed on all server boxes involved. The DTail client (possibly running on a regular Laptop) is used interactively by the user to connect to the servers concurrently. That currently scales to multiple thousands of servers per client. +The DTail binary operates in either client or server mode. The DTail server must be installed on all server boxes involved. The DTail client (possibly running on a regular Laptop) is used interactively to connect to the servers concurrently. That currently scales to multiple thousands of servers per client. ![DTail](doc/dtail.gif "Example") @@ -18,9 +18,9 @@ If you like what you see [look here for more examples](doc/examples.md)! Installation and Usage ====================== -* For simplest setup please follow the [Quick Starting Guide](doc/quickstart.md). -* For a more sustainable setup please follow the [Installation Guide](doc/installation.md). -* Please also have a look at the [Usage Examples](doc/examples.md). +* For the most straightforward setup, please follow the [Quick Starting Guide](doc/quickstart.md). +* For a more sustainable setup, please follow the [Installation Guide](doc/installation.md). +* Please also look at the [Usage Examples](doc/examples.md). More ==== -- cgit v1.2.3 From 17a1431fa4ff3b4ea05de1eff925e132ff63a3ad Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Thu, 27 May 2021 05:02:11 +0100 Subject: add reference to mimecast engineering blog post --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a3e3f30..25b8082 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,7 @@ The DTail binary operates in either client or server mode. The DTail server must ![DTail](doc/dtail.gif "Example") -If you like what you see [look here for more examples](doc/examples.md)! - +If you like what you see [look here for more examples](doc/examples.md)! You can also read through the [DTail Mimecast Engineering Blog Post](https://medium.com/mimecast-engineering/dtail-the-distributed-log-tail-program-79b8087904bb). Installation and Usage ====================== -- cgit v1.2.3 From 4d3fcad045eb254d2182a84fe42bf3d4f563b63f Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Thu, 27 May 2021 05:02:43 +0100 Subject: fix spacing --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 25b8082..f9a7d25 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ The DTail binary operates in either client or server mode. The DTail server must ![DTail](doc/dtail.gif "Example") If you like what you see [look here for more examples](doc/examples.md)! You can also read through the [DTail Mimecast Engineering Blog Post](https://medium.com/mimecast-engineering/dtail-the-distributed-log-tail-program-79b8087904bb). + Installation and Usage ====================== -- cgit v1.2.3