Skip to content

Commit beab4f9

Browse files
committed
modified docs and readme
1 parent ffdd0aa commit beab4f9

File tree

10 files changed

+59
-13
lines changed

10 files changed

+59
-13
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@
44

55
`STJson` is a `Json` parsing library based on the `MIT` open source protocol . The library is purely native implementation does not rely on any library , so it is very light and convenient , and powerful .
66

7-
Full tutorial:
7+
HOME: [https://DebugST.github.io/STJson](https://DebugST.github.io/STJson)
88

9-
CN: [https://DebugST.github.io/STJson/tutorial_cn.html](https://DebugST.github.io/STJson/tutorial_cn.html)
9+
NuGet:
1010

11-
EN: [https://DebugST.github.io/STJson/tutorial_en.html](https://DebugST.github.io/STJson/tutorial_en.html)
11+
```
12+
dotnet add package STLib.Json --version 1.0.0
13+
```
1214

1315
Unlike other `Json` libraries, `STJson` not has objects similar to `JObject` and `JArray`. Just `STJson`. which can be either `Object` or `Array`. `STJson` has two indexers: `STJson[int]` and `STJson[string]`. The type of the current `Json` object can be determined by `STJson.ValueType`.
1416

README_CN.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,9 @@
44

55
`STJson`是一款基于`MIT`开源协议的`Json`解析库。该库纯原生实现不依赖任何库,所以非常轻量便捷,且功能强大。
66

7-
完整教程:
7+
主页: [https://DebugST.github.io/STJson](https://DebugST.github.io/STJson)
88

9-
HOME: [https://DebugST.github.io/STJson](https://DebugST.github.io/STJson)
10-
11-
CN: [https://DebugST.github.io/STJson/tutorial_cn.html](https://DebugST.github.io/STJson/tutorial_cn.html)
12-
13-
EN: [https://DebugST.github.io/STJson/tutorial_en.html](https://DebugST.github.io/STJson/tutorial_en.html)
9+
NuGet: [https://www.nuget.org/packages/STLib.Json](https://www.nuget.org/packages/STLib.Json)
1410

1511
`STJson`不同与其他`Json`库拥有类似与`JObject``JArray`的对象。在`STJson`中仅一个`STJson`对象,它既可以是`Object`,也可以是`Array``STJson`拥有两个索引器:`STJson[int]``STJson[string]`。可通过`STJson.ValueType`确定当前`Json`对象的类型。
1612

Src/STLib.Json/STLib.Json.csproj

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,22 @@
1010
<PackageProjectUrl>https://debugst.github.io/STJson</PackageProjectUrl>
1111
<PackageIcon>STJson.icon.png</PackageIcon>
1212
<PackageTags>json;stlib;debugst;</PackageTags>
13-
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1413
<PackageReadmeFile>README.md</PackageReadmeFile>
1514
<Description>STJson is a Json parsing library based on the MIT open source protocol . The library is purely native implementation does not rely on any library , so it is very light and convenient , and powerful .</Description>
1615
<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
16+
<RepositoryType>git</RepositoryType>
17+
<PackageReleaseNotes>Support Json serialization and deserialization.
18+
Support JsonPath syntax.
19+
Simple data aggregation processing.</PackageReleaseNotes>
20+
<Copyright>Copyright 2022 DebugST</Copyright>
21+
<PackageLicenseFile>LICENSE</PackageLicenseFile>
1722
</PropertyGroup>
1823

1924
<ItemGroup>
25+
<None Include="..\sources\LICENSE">
26+
<Pack>True</Pack>
27+
<PackagePath>\</PackagePath>
28+
</None>
2029
<None Include="..\sources\README.md">
2130
<Pack>True</Pack>
2231
<PackagePath>\</PackagePath>

Src/sources/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 DebugST
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

docs/css/index.css

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,17 @@ a:hover{
9696
}
9797
.img_good{
9898
animation: good 2s infinite;
99+
}
100+
.span_note{
101+
display: inline-block;
102+
background-color: goldenrod;
103+
font-size: 12px;
104+
color: white;
105+
position: absolute;
106+
z-index: 2;
107+
left: 50%;
108+
transform: translate(-50%, 0);
109+
padding: 2px 10px;
110+
border-radius: 0px 0px 5px 5px;
111+
white-space: nowrap;
99112
}

docs/favicon.png

4.14 KB
Loading

docs/images/STJson.icon.png

4.14 KB
Loading

docs/index.html

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0">
66
<title>STJson - Home</title>
7+
<link rel="shortcut icon" href="./favicon.png" type="image/png"/>
78
<link rel="stylesheet" type="text/css" href="./css/index.css"/>
89
<script type="text/javascript" src="./js/jquery-1.10.2.min.js"></script>
910
<script type="text/javascript">
@@ -23,11 +24,12 @@
2324
<a class="a_lua" href="javascript:void(0);" id="a_lua_cn" style="left:10px;top:10px">CN</a>
2425
<a class="a_lua" href="javascript:void(0);" id="a_lua_en" style="left:10px;top:50px;">EN</a>
2526
<div id="div_cn">
27+
<span class="span_note">这是一个很严肃的主页</span>
2628
<div class="div_top">
2729
<div class="div_top_content">
2830
<h1>STLib.Json</h1>
2931
<p>一款轻量级Json操作库,功能强大且使用简单。Emm...反正就是很强大。。。很简单。。。</p>
30-
<a class="a_button" style="background-color:cornflowerblue" href="./tutorial_cn.html">Document</a><!--
32+
<a class="a_button" style="background-color:cornflowerblue" href="./tutorial_cn.html">在线教程</a><!--
3133
--><a class="a_button" style="background-color:limegreen" href="https://github.com/DebugST/STJson">GitHub</a>
3234
<p style="font-size:12px;">版本:1.0</p>
3335
</div>
@@ -47,17 +49,18 @@ <h1>STLib.Json</h1>
4749
</div>
4850
<div class="div_bottom">
4951
<div style="position:absolute;left:50%;top:50%;transform:translate(-50%,-50%);">
50-
<p style="color:white;">哇喔。。。快看!石头好帅!!!</p>
52+
<p style="color:white;">哇喔。。。快看!石头好TM帅!!!</p>
5153
<p style="font-size:12px;color:white">2023-06-08</p>
5254
</div>
5355
</div>
5456
</div>
5557
<div id="div_en" style="display:none">
58+
<span class="span_note">This is a very serious home page.</span>
5659
<div class="div_top">
5760
<div class="div_top_content">
5861
<h1>STLib.Json</h1>
5962
<p>A lightweight Json manipulation library that is powerful and easy to use. Emm...Anyway...it's p...p...powerful. v...v...very simple.</p>
60-
<a class="a_button" style="background-color:cornflowerblue" href="./tutorial_en.html">Document</a><!--
63+
<a class="a_button" style="background-color:cornflowerblue" href="./tutorial_en.html">Tutorial</a><!--
6164
--><a class="a_button" style="background-color:limegreen" href="https://github.com/DebugST/STJson">GitHub</a>
6265
<p style="font-size:12px;">Version:1.0</p>
6366
</div>

docs/tutorial_cn.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0">
66
<title>STJson</title>
7+
<link rel="shortcut icon" href="./favicon.png" type="image/png"/>
78
<link rel="stylesheet" type="text/css" href="./css/stdoc.css"/>
89
<script type="text/javascript" src="./js/jquery-1.10.2.min.js"></script>
910
<script type="text/javascript" src="./js/stdoc.js"></script>

docs/tutorial_en.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0">
66
<title>STJson</title>
7+
<link rel="shortcut icon" href="./favicon.png" type="image/png"/>
78
<link rel="stylesheet" type="text/css" href="./css/stdoc.css"/>
89
<script type="text/javascript" src="./js/jquery-1.10.2.min.js"></script>
910
<script type="text/javascript" src="./js/stdoc.js"></script>

0 commit comments

Comments
 (0)