chore: added docs

scalar · May 24, 2024 · 3d61d04 · 3d61d04
1 parent 4aa4401
commit 3d61d04
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -193,11 +193,12 @@ Install them via `npm`:
 npm install @scalar/api-reference
 ```
 
-And import the `ApiReference` component to your app:
+And import the `ApiReference` component and style to your app:
 
 ```vue
 <script setup lang="ts">
 import { ApiReference } from '@scalar/api-reference'
+import '@scalar/api-reference/style.css'
 </script>
 
 <template>
@@ -218,6 +219,7 @@ We have created a client side wrapper in React:
 
 ```ts
 import { ApiReferenceReact } from '@scalar/api-reference-react'
+import '@scalar/api-reference-react/style.css'
 import React from 'react'
 
 function App() {
@@ -455,7 +457,7 @@ use aide::{
 `go-scalar-api-reference` by [@MarceloPetrucio](https://github.com/MarceloPetrucio/) offers a convenient way to generate
 API references in Go:
 
-https://github.com/MarceloPetrucio/go-scalar-api-reference/
+<https://github.com/MarceloPetrucio/go-scalar-api-reference/>
 
 ### Free Hosting
 

diff --git a/packages/api-reference-react/README.md b/packages/api-reference-react/README.md
@@ -15,6 +15,7 @@ npm install @scalar/api-reference-react
 
 ```ts
 import { ApiReferenceReact } from '@scalar/api-reference-react'
+import '@scalar/api-reference-react/style.css'
 import React from 'react'
 
 function App() {

diff --git a/packages/api-reference/README.md b/packages/api-reference/README.md
@@ -21,6 +21,7 @@ npm install @scalar/api-reference
 ```vue
 <script setup>
 import { ApiReference } from '@scalar/api-reference'
+import '@scalar/api-reference/style.css'
 </script>
 
 <template>