Skip to content

Commit

Permalink
Fixed markup in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Toparvion authored Jan 27, 2019
1 parent fa1fb31 commit 15cbf0b
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# AnaLóg

AnaLog (pronounced with stressed "*o*") is a tool for convenient real-time displaying of various logs in your browser.
Think of it as of web interface to traditional [tail](https://ru.wikipedia.org/wiki/Tail) utility
AnaLog (pronounced with stressed "*o*") is a tool for convenient real-time displaying of various logs in your browser.
Think of it as of web interface to traditional [tail](https://en.wikipedia.org/wiki/Tail_(Unix)) utility
with a bunch of improvements:
* log level syntax highlighting
* predefined and on-demand log choice configuration (via YAML or URL correspondingly)
Expand All @@ -23,26 +23,27 @@ in its development, please feel free to [contact the author](mailto:toparvion@gm

## What it looks like?
### For end users
Click on the following images to see them in full size.
Click the images to see them in full size.

<a href="https://raw.githubusercontent.com/wiki/Toparvion/analog/images/composite-example.png">
<img src="https://raw.githubusercontent.com/wiki/Toparvion/analog/images/composite-example.png" align="left" height="200">
<img src="https://raw.githubusercontent.com/wiki/Toparvion/analog/images/composite-example.png" height="170">
</a>&nbsp;
<a href="https://raw.githubusercontent.com/wiki/Toparvion/analog/images/choices-example.png">
<img src="https://raw.githubusercontent.com/wiki/Toparvion/analog/images/choices-example.png" align="left" height="200">
<img src="https://raw.githubusercontent.com/wiki/Toparvion/analog/images/choices-example.png" height="170">
</a>&nbsp;
<a href="https://raw.githubusercontent.com/wiki/Toparvion/analog/images/dialogs-example.png">
<img src="https://raw.githubusercontent.com/wiki/Toparvion/analog/images/dialogs-example.png" align="left" height="200">
<img src="https://raw.githubusercontent.com/wiki/Toparvion/analog/images/dialogs-example.png" height="170">
</a>

### For administrator
In case of AnaLog the administrator is a person who installs and
configures AnaLog instances. From the administrator's perspective AnaLog:
configures AnaLog instances.
From the administrator's perspective AnaLog:
* is standalone Java application with built-in web server (based on [Spring Boot](https://spring.io/projects/spring-boot) framework)
* works on Java 11 and above
* works on [Java 11](http://jdk.java.net/11/) and above
* has flexible configuration in 2 YAML files: for system settings and log choices (see [examples](https://github.com/Toparvion/analog/wiki))
* must be installed on every server where the file logs must be fetched from
* relies on `tail`, `docker` and `kubectl` binaries to fetch logs from corresponding resources.
* relies on `tail`, `docker` and `kubectl` binaries to fetch logs from corresponding sources.

## Installation & Usage
1. Download `analog.zip` from [latest release](https://github.com/Toparvion/analog/releases/latest) page
Expand All @@ -66,4 +67,4 @@ comprehensive documentation nor support. Some basic information can be
found on [Wiki pages](https://github.com/Toparvion/analog/wiki).
Nevertheless the author would be glad to help you with any questions
concerning AnaLog usage. You can ask for help
by means of an [issue](https://github.com/Toparvion/analog/issues/new).
by means of an [issue](https://github.com/Toparvion/analog/issues/new).

0 comments on commit 15cbf0b

Please sign in to comment.