diff --git a/README.md b/README.md index c929330..869625b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # vss -A static site generator +Easy-to-use static site generator + +![CI](https://github.com/zztkm/vss/workflows/CI/badge.svg) ## Caution @@ -9,16 +11,23 @@ Be aware that destructive changes will be made if you use it! ## Feature -- Create site content with markdown - Easy to use +- Create site content with markdown + +## Installation -## Install +### Get the binary +Download from [Releases](https://github.com/zztkm/vss/releases) + +### Build from source ``` git clone https://github.com/zztkm/vss.git cd vss -v vss.v +v install markdown + +v . -o vss ``` ## Usage @@ -118,4 +127,8 @@ dist

about page

-``` \ No newline at end of file +``` + +## Example + +Examples can be found at the [example](https://github.com/zztkm/vss/tree/main/example) directory.