Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update documentation files and links #9

Merged
merged 1 commit into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _docs/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export default defineAppConfig({
description: 'A Node.js package providing efficient caching using the file system for storage',
image: 'https://ndragun92.github.io/file-sys-cache/cover.jpg',
socials: {
github: 'ndragun92/file-sys-cache',
github: 'ndragun92/file-sys-cache'
},
aside: {
level: 1,
Expand Down
2 changes: 1 addition & 1 deletion _docs/content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ cta:
- /introduction/getting-started
secondary:
- Open on GitHub →
- https://github.com/nuxt-themes/docus
- https://github.com/ndragun92/file-sys-cache
---

#title
Expand Down
6 changes: 5 additions & 1 deletion _docs/content/1.introduction/1.getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Getting Started

File-Sys-Cache is an npm package that provides a simple and efficient system files-based caching solution for Node.js applications.
___

## How to install?

Expand All @@ -12,4 +13,7 @@ npm install file-sys-cache

::alert{type="info"}
🛈 Node 20.x or greater is preferred
::
::

___
:button-link[Visit on npm]{icon="logos:npm-2" href="https://www.npmjs.com/package/file-sys-cache" blank}