Skip to content

Commit 56f2ba5

Browse files
committed
2022.6.2-Client(update README.md and README-en.md)
1 parent b14f66f commit 56f2ba5

2 files changed

Lines changed: 25 additions & 32 deletions

File tree

README-en.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Optilog
1+
# [Optilog-Client](https://github.com/OptiJava/Optilog-Client)
22

33
![Build](https://img.shields.io/badge/Build-Passing-green)
44
[![Latest-Release](https://img.shields.io/badge/Release-Latest-blue)](https://github.com/OptiJava/Optilog-Client/releases/latest)
55

6-
[![Languege](https://img.shields.io/badge/Language-EnglishPage-red)](https://github.com/OptiJava/Optilog-Client/blob/master/README-en.md)
7-
| [![Languege](https://img.shields.io/badge/Language-ChinesePage-green)](https://github.com/OptiJava/Optilog-Client/blob/master/README.md)
6+
[中文](https://github.com/OptiJava/Optilog-Client/blob/master/README.md) |
7+
[English](https://github.com/OptiJava/Optilog-Client/blob/master/README-en.md)
88

99
**This is an open source logging framework written in java. Optilog has
1010
more [advantages](https://github.com/OptiJava/Optilog-Client#optilog%E7%9A%84%E4%BC%98%E5%8A%BF) than other open source
@@ -18,12 +18,7 @@ project [wiki](https://github.com/OptiJava/Optilog-Client/wiki) before use Optil
1818
If you like, you are welcome to contribute to Optilog through fork. The code of this project is quite basic. Anyone can
1919
contribute.
2020

21-
# Precautions:
22-
23-
For a whole java project, it is recommended to use only one initialized instance in the whole process, otherwise there
24-
will be a bug! (see wiki for details)(expect when you need change setting file)
25-
26-
# Optilog advantages
21+
## Optilog advantages
2722

2823
1.High performance: After initialization log, output a log (output to the screen + output to a file + output to the
2924
server through socket) only takes 8 milliseconds at most (it will be optimized later), and log4j takes at least 41
@@ -57,27 +52,29 @@ examples
5752
11.Support configuration files in multiple formats, including JSON,YAML, XML and properties. Support for toml
5853
configuration files will be added later
5954

60-
# Defects of optilog
55+
## Defects of optilog
6156

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

64-
# Optilog log picture:
59+
## Optilog log picture:
6560

6661
![image](https://user-images.githubusercontent.com/106148777/170864247-7da18dd5-f5b9-4e5c-aee7-4174d29a8969.png)
62+
_Generate by [carbon.now.sh](https://carbon.now.sh)_
6763

68-
# Dependency:
64+
## Dependency:
6965

70-
`Gson-2.9.0` `jackson-dataformat-xml-2.13.3` `snakeyaml-1.30`(You needn't add dependency if you don't use these
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
7168
function.)
7269

73-
# Author:
70+
## Author:
7471

7572
OptiJava
7673

77-
# Contributor:
74+
## Contributor:
7875

7976
JavauserO
8077

81-
# Future plans
78+
## Future plans
8279

8380
realize remote call

README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
![Build](https://img.shields.io/badge/Build-Passing-green)
44
[![Latest-Release](https://img.shields.io/badge/Release-Latest-blue)](https://github.com/OptiJava/Optilog-Client/releases/latest)
55

6-
[![Languege](https://img.shields.io/badge/Language-EnglishPage-red)](https://github.com/OptiJava/Optilog-Client/blob/master/README-en.md)
7-
| [![Languege](https://img.shields.io/badge/Language-ChinesePage-green)](https://github.com/OptiJava/Optilog-Client/blob/master/README.md)
6+
[中文](https://github.com/OptiJava/Optilog-Client/blob/master/README.md) |
7+
[English](https://github.com/OptiJava/Optilog-Client/blob/master/README-en.md)
88

99
_截止目前,Optilog代码总量3262行!_
1010

11-
**_See English README.md page in [English Page](https://github.com/OptiJava/Optilog-Client/blob/master/README-en.md)_**
12-
1311
这是一个用java语言编写的开源日志框架,他相比现在其他开源日志框架(比如log4j,slf4j)有更多的[优势](https://github.com/OptiJava/Optilog-Client#optilog%E7%9A%84%E4%BC%98%E5%8A%BF)
1412

1513
Optilog的Wiki随时会更新,有问题在Issues问,使用前一!定!看[本项目Wiki](https://github.com/OptiJava/Optilog-Client/wiki)
@@ -18,11 +16,7 @@ Optilog的Wiki随时会更新,有问题在Issues问,使用前一!定!看
1816

1917
_如果你愿意,欢迎Fork这个仓库为Optilog做出贡献,本项目的代码比较基础,任何人都可以做出贡献~~包括不会编程的人,因为他们可以写教程~~_
2018

21-
# 注意事项:
22-
23-
**一整个java项目建议全程只用一个初始化出来的实例,不然会出bug**
24-
25-
# Optilog的优势
19+
## Optilog的优势
2620

2721
1.性能高:在初始化后,再输出一条日志(输出到屏幕+输出到文件+通过socket输出到服务端) 最快只需要8毫秒(后续还会再优化),log4j至少41毫秒
2822

@@ -48,26 +42,28 @@ _如果你愿意,欢迎Fork这个仓库为Optilog做出贡献,本项目的
4842

4943
12.Optilog支持在运行期修改配置,当然只能修改true和false的一些配置项,输出文件路径什么的不能修改
5044

51-
# Optilog的缺陷
45+
## Optilog的缺陷
5246

5347
1.没有对jdbc的支持 <-在2022/6/7最新的提交中,已经新增了将日志输出到DataBase的支持~~你们肯定不知道我装mysql装了5遍才成功~~
5448

55-
# Optilog输出日志预览:
49+
## Optilog输出日志预览:
5650

5751
![image](https://user-images.githubusercontent.com/106148777/170864247-7da18dd5-f5b9-4e5c-aee7-4174d29a8969.png)
52+
_使用[carbon.now.sh](https://carbon.now.sh)生成_
5853

59-
# Dependency:
54+
## Dependency:
6055

61-
`Gson-2.9.0` `jackson-dataformat-xml-2.13.3` `org.yaml-1.30`(如果你只用properties作为配置文件的话Gson,Jackson,snakeyaml也可以不加)
56+
`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`
57+
(如果你只用properties作为配置文件的话Gson,Jackson,snakeyaml也可以不加,mysql不用也可以不加)
6258

63-
# Author:
59+
## Author:
6460

6561
`OptiJava`
6662

67-
# Contributor:
63+
## Contributor:
6864

6965
`JavaUserO`
7066

71-
# 未来计划
67+
## 未来计划
7268

7369
实现远程调用

0 commit comments

Comments
 (0)