docs(Readme): update readme content [skip ci]

snowcrystals · May 8, 2023 · d47fd91 · d47fd91
1 parent 8f7a206
commit d47fd91
Showing 1 changed file with 4 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@
   </a>
   <br />
    <a href="https://vercel.com/?utm_source=snowcrystals&utm_campaign=oss" target="_blank">
-    <img src="https://raw.githubusercontent.com/snowcrystals/.github/main/vercel.svg" width="20%">
+    <img src="https://raw.githubusercontent.com/snowcrystals/.github/main/vercel.svg">
   </a>
 </div>
 
@@ -31,33 +31,10 @@
 
 ## Install
 
-```
-npm i @snowcrystals/icicle
-yarn add @snowcrystals/icicle
-```
-
-The following example is written using TypeScript.
-```ts
-import { Logger } from "@snowcrystals/icicle";
-const icicle = new Logger();
-icicle.info("Hello World!"); // 2022-11-25 20:18:33 [INFO] » Hello World!
-```
-
-## Options
-
-The following options apply to the `Logger` class.
-
-| Property      | Value               | Required | Description                                                                                                                                |
-| ------------- | ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| console       | Console             | false    | The Console for the logs.                                                                                                                  |
-| stdout        | NodeJS.WriteStream  | false    | The WriteStream for the output logs.                                                                                                       |
-| stderr        | NodeJS.WriteStream  | false    | A WriteStream for the error logs.                                                                                                          |
-| defaultFormat | LoggerLevelOptions  | false    | The default options used to fill all the possible values for Format.                                                                       |
-| format        | LoggerFormatOptions | false    | The options for each log level. LogLevel.None serves to set the default for all keys, where only TimeStamp and Prefix would be overridden. |
-| level         | LogLevel            | false    | The minimum log level.                                                                                                                     |
-| join          | string              | false    | The string that joins different messages.                                                                                                  |
-| depth         | number              | false    | The inspect depth when logging objects.                                                                                                    |
+```,npm i @snowcrystals/icicle,yarn add @snowcrystals/icicle,```
+,The following example is written using TypeScript.,```ts,import { Logger } from "@snowcrystals/icicle";,const icicle = new Logger();,icicle.info("Hello World!"); // 2022-11-25 20:18:33 [INFO] » Hello World!,```
 
+.github/readme_extension.md
 
 ## Author