update README.dm

Author: findmyway

Project.toml

@@ -3,6 +3,12 @@ uuid = "408f5b3e-f2a2-48a6-b4bb-c8aa44c458e6"
 authors = ["Jun Tian <[email protected]> and contributors"]
 version = "0.1.0"
 
+[deps]
+FillArrays = "1a297f60-69ca-5386-bcde-b61e274b549b"
+IntervalSets = "8197267c-284f-5f27-9208-e0e47529a953"
+Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
+StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
+
 [compat]
 julia = "1.6"
 

README.md

@@ -6,3 +6,32 @@
 [![Coverage](https://codecov.io/gh/JuliaReinforcementLearning/CommonRLSpaces.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaReinforcementLearning/CommonRLSpaces.jl)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 [![PkgEval](https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/C/CommonRLSpaces.svg)](https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/report.html)
+
+## Usage
+
+### Construction
+
+|Category|Style|Example|
+|:---|:----|:-----|
+|Enumerable discrete space| `DiscreteSpaceStyle{2, ()}()` | `Space((:cat, :dog))`, `Space(0:1)`, `Space(1:2)`, `Space(Bool)`|
+|Multi-dimensional discrete space| `DiscreteSpaceStyle{2, (3,4)}()` | `Space((:cat, :dog), 3, 4)`, `Space(0:1, 3, 4)`, `Space(1:2, 3, 4)`, `Space(Bool, 3, 4)`|
+|Multi-dimensional variable discrete space| `DiscreteSpaceStyle{(2,)}()` | `Space(SVector((:cat, :dog), (:litchi, ：longan, ：mango))`, `Space([-1:1, (false, true)])`|
+|Continuous space| `ContinuousSpaceStyle()` | `Space(-1.2..3.3)`, `Space(Float32)`|
+|Multi-dimensional continuous space| `ContinuousSpaceStyle{(3,4)}()` | `Space(-1.2..3.3, 3, 4)`, `Space(Float32, 3, 4)`|
+
+### API
+
+### Size Info
+
+```julia
+```
+
+#### Sampling
+
+```julia
+```
+
+### Existence Checking
+
+```julia
+```

src/CommonRLSpaces.jl

@@ -1,5 +1,11 @@
 module CommonRLSpaces
 
-# Write your package code here.
+using Reexport
+
+@reexport using FillArrays
+@reexport using IntervalSets
+@reexport using StaticArrays
+
+include("basic.jl")
 
 end

src/basic.jl

@@ -0,0 +1,3 @@
+struct Space{T}
+    s::T
+end