Skip to content

Commit f2d1de8

Browse files
authored
Update README-en.md
1 parent ca503af commit f2d1de8

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

README-en.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ project [wiki](https://github.com/OptiJava/Optilog-Client/wiki) before use Optil
1515

1616
[OptilogServer](https://github.com/OptiJava/Optilog-Server) matched with OptilogClient. See wiki for details.
1717

18-
If you like, you are welcome to contribute to Optilog through fork. The code of this project is quite basic. Anyone can
19-
contribute.
18+
_If you like, you are welcome to contribute to Optilog through fork. The code of this project is quite basic. Anyone can
19+
contribute._
2020

2121
## Optilog advantages
2222

@@ -29,32 +29,32 @@ supports 9 placeholders.
2929

3030
3.The configuration file can be placed in any location. The name of the configuration file is unlimited. Two types of
3131
configuration files are supported. In log4j, the configuration file can only be in classpath and the name can only be
32-
log4j2 XML
32+
log4j2 XML.
3333

34-
4.Support the client to send logs to the server(See details in [wiki](https://github.com/OptiJava/Optilog-Client/wiki)'
35-
s 'use OptilogServer' Page,Download OptilogServer in [OptilogServer](https://github.com/OptiJava/Optilog-Server))
34+
4.Support the client to send logs to the server(See details in [wiki](https://github.com/OptiJava/Optilog-Client/wiki)
35+
Download OptilogServer in [OptilogServer](https://github.com/OptiJava/Optilog-Server)).
3636

37-
5.All possible exceptions in optilog are captured without affecting the main logic
37+
5.All possible exceptions in optilog are captured without affecting the main logic.
3838

3939
6.You only need one jar package, and you can use it directly by typing in the classpath (I don't know the feeling of
40-
adding dozens of jar packages at once when using gradle)
40+
adding dozens of jar packages at once when using gradle).
4141

42-
7.Suitable for beginners without complex configuration files
42+
7.Suitable for beginners without complex configuration files.
4343

44-
8.There are few dependencies
44+
8.There are few dependencies.
4545

4646
9.Class, method and other information output in the log is absolutely accurate, because optilog uses stacktrace to
47-
determine this information internally, and there is no need to write the class instance when initializing the log
47+
determine this information internally, and there is no need to write the class instance when initializing the log.
4848

4949
10.Optilog can directly generate a default configuration file. Beginners do not need to look for configuration file
50-
examples
50+
examples.
5151

5252
11.Support configuration files in multiple formats, including JSON,YAML, XML and properties. Support for toml
53-
configuration files will be added later
53+
configuration files will be added later.
5454

55-
## Defects of optilog
55+
## Defects of Optilog
5656

57-
1. No JDBC support <- On 2022/6/7,Optilog can send log to DataBase,Optilog already support jdbc!!!
57+
1. No JDBC support <- On 2022/6/7,Optilog can send log to DataBase,Optilog already support send log to jdbc
5858

5959
## Optilog log picture:
6060

@@ -63,9 +63,15 @@ _Generate by [carbon.now.sh](https://carbon.now.sh)_
6363

6464
## Dependency:
6565

66-
`com.google.code.gson:gson:2.9.0` `com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.13.3` `org.yaml:snakeyaml:1.30` `mysql:mysql-connector-java:8.0.29`(
67-
You needn't add dependency if you don't use these
68-
function.)
66+
`com.google.code.gson:gson:2.9.0`
67+
\
68+
`com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.13.3`
69+
\
70+
`org.yaml:snakeyaml:1.30` `mysql:mysql-connector-java:8.0.29`
71+
\
72+
`mysql:mysql-connector-java:8.0.29`
73+
\
74+
(You needn't add dependency if you don't use these function.)
6975

7076
## Author:
7177

0 commit comments

Comments
 (0)