Skip to content

Commit 366631c

Browse files
committed
feat: update readme
1 parent ab4a2b7 commit 366631c

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# asciinema parser
1+
# asciinema parser
22

3-
[中文文档](./README.md)
4-
[English Document](./README_en.md)
3+
[English Document](./README.md)
4+
[中文文档](./README_zh.md)
55

6-
# 一、这是什么?解决了什么问题?
6+
# 1. What is this? What problem was solved?
77

8-
这个网站[https://asciinema.org/](https://asciinema.org/)是一个命令行录屏分享网站,它定义了一套`Ascii Cast`格式的文件来存储录屏内容,这个库就是用来解析`Ascii Cast`文件的,支持[v1](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v1.md)[v2](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md)两个版本。
8+
This website [https://asciinema.org/](https://asciinema.org/) Is a command line screen sharing website, it defines a set of Ascii Cast format files to store screen content, this library is used to parse Ascii Cast files,support [v1](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v1.md) and [v2](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md) two versions.
99

10-
# 二、 API代码示例
10+
# 2. API code examples
1111

12-
## 2.1 检查录屏文件是哪个版本
12+
## 2.1 Check the version of the screen recording file
1313

1414
```go
1515
package main
@@ -28,7 +28,6 @@ func main() {
2828
[2.143733, "o", " "]
2929
[6.541828, "o", "Bye!"]`
3030

31-
// 识别版本
3231
version, err := asciinema_parser.DetectVersion(context.Background(), asciiCastV2String)
3332
if err != nil {
3433
panic(err)
@@ -38,7 +37,7 @@ func main() {
3837
}
3938
```
4039

41-
## 2.2 解析V1格式的录屏软件
40+
## 2.2 Parse V1 format of the screen recording software
4241

4342
```go
4443
package main
@@ -83,7 +82,7 @@ func main() {
8382
}
8483
```
8584

86-
## 2.3 解析V2格式的录屏软件
85+
## 2.3 Parse V2 format of the screen recording software
8786

8887
```go
8988
package main

README_en.md renamed to README_zh.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# asciinema parser
22

3-
[中文文档](./README.md)
4-
[English Document](./README_en.md)
3+
[English Document](./README.md)
4+
[中文文档](./README_zh.md)
55

6-
# 1. What is this? What problem was solved?
6+
# 一、这是什么?解决了什么问题?
77

8-
This website [https://asciinema.org/](https://asciinema.org/) Is a command line screen sharing website, it defines a set of Ascii Cast format files to store screen content, this library is used to parse Ascii Cast files,support [v1](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v1.md) and [v2](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md) two versions.
8+
这个网站[https://asciinema.org/](https://asciinema.org/)是一个命令行录屏分享网站,它定义了一套`Ascii Cast`格式的文件来存储录屏内容,这个库就是用来解析`Ascii Cast`文件的,支持[v1](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v1.md)[v2](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md)两个版本。
99

10-
# 2. API code examples
10+
# 二、 API代码示例
1111

12-
## 2.1 Check the version of the screen recording file
12+
## 2.1 检查录屏文件是哪个版本
1313

1414
```go
1515
package main
@@ -28,6 +28,7 @@ func main() {
2828
[2.143733, "o", " "]
2929
[6.541828, "o", "Bye!"]`
3030

31+
// 识别版本
3132
version, err := asciinema_parser.DetectVersion(context.Background(), asciiCastV2String)
3233
if err != nil {
3334
panic(err)
@@ -37,7 +38,7 @@ func main() {
3738
}
3839
```
3940

40-
## 2.2 Parse V1 format of the screen recording software
41+
## 2.2 解析V1格式的录屏软件
4142

4243
```go
4344
package main
@@ -82,7 +83,7 @@ func main() {
8283
}
8384
```
8485

85-
## 2.3 Parse V2 format of the screen recording software
86+
## 2.3 解析V2格式的录屏软件
8687

8788
```go
8889
package main

0 commit comments

Comments
 (0)