Docs: README update #60

README.md

@@ -2,12 +2,16 @@
 Natural CSS in the Typescript
 
 > [!WARNING]
-> This project is still in its initial stage, which means it is not ready for production.
+> This project is still in WIP, which means it is not ready for production.
 
 <p align="center">
   <img src="./assets/logo.png" alt="logo" width="300" height="300">
 </p>
 
+## Documentation
+
+See [`@mincho-js/css`](./packages/css) README.
+
 ## Motivation
 
 It started with contemplation on approaches and management methods for CSS styling.
@@ -67,7 +71,7 @@ However, since we cannot provide all features from the beginning, we plan to ach
 Currently, most of the features are related to the CSS preprocessor.
 
 - [CSS Literals](https://github.com/mincho-js/working-group/blob/main/text/000-css-literals.md): Expressing more natural CSS in Typescript.
-- [CSS Nesting(WIP)](https://github.com/mincho-js/working-group/blob/main/text/001-css-nesting.md): Expressing better nesting and referencing.
+- [CSS Nesting](https://github.com/mincho-js/working-group/blob/main/text/001-css-nesting.md): Expressing better nesting and referencing.
 
 ## Contributing
 

packages/css-additional-types/README.md

@@ -1,3 +1,33 @@
 # @mincho-js/css-additional-types
 
 The @mincho-js/css-additional-types supplies the type generated by the automation.
+
+## Install
+
+```shell
+npm install @mincho-js/css-additional-types
+
+# or
+yarn add @mincho-js/css-additional-types
+
+# or
+pnpm install @mincho-js/css-additional-types
+```
+
+## API
+
+The following is a list of extended types and predeclared objects.
+
+### Types
+
+1. `CamelPseudos`: Camelised pseudo selectors and pseudo elements instead of kebabs
+2. `SpacePropertiesKey`: Property keys with values that can be merged into Space
+3. `CommaPropertiesKey`: Property keys with values that can be merged into Comma
+4. `ShorthandProperties`: Shorthand properties
+5. `NestedPropertiesMap`: When a shorthand property appears as a nested
+
+
+### Objects
+
+1. `shorthandProperties`: Actual value of `ShorthandProperties`
+2. `nestedPropertiesMap`: Actual value of `NestedPropertiesMap`