Skip to content

Commit 7696284

Browse files
committed
docs: update docs and workflows required for Libplanet.Node
1 parent 2a67bc7 commit 7696284

File tree

4 files changed

+33
-3
lines changed

4 files changed

+33
-3
lines changed

.github/bin/constants.sh

+4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
# shellcheck disable=SC2034
44
solution="Libplanet"
55
projects=(
6+
"sdk/node/Libplanet.Node"
7+
"sdk/node/Libplanet.Executable"
8+
"sdk/node/Libplanet.Extensions"
69
"src/Libplanet"
710
"src/Libplanet.Action"
811
"src/Libplanet.Common"
@@ -24,6 +27,7 @@ projects=(
2427
)
2528
configuration=Release
2629
executables=(
30+
"sdk/node/Libplanet.Executable"
2731
"tools/Libplanet.Tools"
2832
"tools/Libplanet.Explorer.Executable"
2933
)

CONTRIBUTING.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ on GitHub consists of several projects. There are two types of projects:
151151

152152
- *Libplanet.Tools*: The CLI tools for Libplanet. This project is distributed
153153
as a distinct NuGet package: *[Libplanet.Tools]*. See its own
154-
[README.md](Libplanet.Tools/README.md).
154+
[README.md](tools/Libplanet.Tools/README.md).
155155

156156
- *Libplanet.Explorer*: Libplanet Explorer, a web server that exposes
157157
a Libplanet blockchain as a [GraphQL] endpoint. There is the official
@@ -166,6 +166,16 @@ on GitHub consists of several projects. There are two types of projects:
166166
- *Libplanet.Explorer.Executable*: (**DEPRECATED**) Turns Libplanet Explorer
167167
into a single executable binary so that it is easy to distribute.
168168

169+
- *Libplanet.Node*: Library used to build libplanet node easily.
170+
This project is distributed as a distinct NuGet package: *[Libplanet.Node]*.
171+
See its own [README.md](sdk/node/Libplanet.Node/README.md).
172+
173+
- *Libplanet.Node.Extensions*: Provides extensions methods for
174+
*Libplanet.Node*.
175+
176+
- *Libplanet.Node.Executable*: Turns Libplanet Node into a single executable
177+
binary so that it is easy to distribute.
178+
169179
- *Libplanet.Benchmarks*: Performance benchmarks.
170180
See the [*Benchmarks*](#benchmarks) section below.
171181

@@ -199,6 +209,8 @@ on GitHub consists of several projects. There are two types of projects:
199209
- *Libplanet.Extensions.Cocona.Tests*: Unit tests for the
200210
*Libplanet.Extensions.Cocona* project.
201211

212+
- *Libplanet.Node.Tests*: Unit tests for the *Libplanet.Node* project.
213+
202214

203215
[NuGet package]: https://www.nuget.org/packages/Libplanet/
204216
[Libplanet.Net]: https://www.nuget.org/packages/Libplanet.Net/
@@ -211,6 +223,7 @@ on GitHub consists of several projects. There are two types of projects:
211223
[Libplanet.RocksDBStore]: https://www.nuget.org/packages/Libplanet.RocksDBStore/
212224
[Libplanet.Analyzers]: https://www.nuget.org/packages/Libplanet.Analyzers/
213225
[Cocona]: https://www.nuget.org/packages/Cocona
226+
[Libplanet.Node]: https://www.nuget.org/packages/Libplanet.Node
214227
[Libplanet.Extensions.Cocona]: https://www.nuget.org/packages/Libplanet.Extensions.Cocona
215228
[Libplanet.Tools]: https://www.nuget.org/packages/Libplanet.Tools/
216229
[GraphQL]: https://graphql.org/

hooks/check-projects

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ if ! [[ -f "$SOLUTION" ]]; then
99
fi
1010

1111
list-projects() {
12-
dotnet sln "$SOLUTION" list | grep -E $'(src|tools|test).+\\...proj\r?$' | sed 's/[/][^/]*$//'
12+
dotnet sln "$SOLUTION" list | grep -E $'(src|tools|node|test).+\\...proj\r?$' | sed 's/[/][^/]*$//'
1313
}
1414

1515
# shellcheck source=.github/bin/constants.sh
@@ -26,7 +26,7 @@ check-github-actions() {
2626
}
2727

2828
check-contributing() {
29-
name=$(echo "$1" | sed -re 's/(src|tools|test)\///')
29+
name=$(echo "$1" | sed -re 's/(src|tools|node|test)\///')
3030
if ! grep -E "^ - \*$name\*: " CONTRIBUTING.md > /dev/null; then
3131
echo "The project $1 is not documented in the CONTRIBUTING.md file." \
3232
> /dev/stderr

sdk/node/Libplanet.Node/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Libplanet Node
2+
==============
3+
4+
[![NuGet][nuget-badge]][NuGet]
5+
[![NuGet (prerelease)][nuget-prerelease-badge]][NuGet]
6+
7+
This library is a collection of utilities for application programmers who
8+
create a blockchain node powered by [Libplanet].
9+
10+
[NuGet]: https://www.nuget.org/packages/Libplanet.Node/
11+
[nuget-badge]: https://img.shields.io/nuget/v/Libplanet.Node.svg?style=flat
12+
[nuget-prerelease-badge]: https://img.shields.io/nuget/vpre/Libplanet.Node.svg?style=flat
13+
[Libplanet]: https://libplanet.io/

0 commit comments

Comments
 (0)