Skip to content

Commit

Permalink
chore: improve documentation and guide
Browse files Browse the repository at this point in the history
  • Loading branch information
MilosPaunovic committed Jun 15, 2024
1 parent 94dcde5 commit 5c81bc0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

A versatile collection of utility functions for simplifying JavaScript development.

## ⚡️ Online Playground

[Open in CodePen](https://codepen.io/milospaunovic/pen/oNRpBoz?editors=0012)

## 🚀 Features

- 📝 Strings - Versatile utilities for generating and manipulating strings.
Expand All @@ -31,6 +35,9 @@ pnpm add --save-dev @paunovic/utils
// Importing specific function using ESM syntax
import { uniqueIdentifier } from '@paunovic/utils'

// Importing specific function directly from the URL
import { uniqueIdentifier } from 'https://unpkg.com/@paunovic/utils'

// Importing specific function using CommonJS syntax
const { uniqueIdentifier } = require('@paunovic/utils')

Expand Down
7 changes: 7 additions & 0 deletions docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ next: false

A versatile collection of utility functions for simplifying JavaScript development.

## ⚡️ Online Playground

[Open in CodePen](https://codepen.io/milospaunovic/pen/oNRpBoz?editors=0012)

## 📦 Install

```bash
Expand All @@ -27,6 +31,9 @@ pnpm add --save-dev @paunovic/utils
// Importing specific function using ESM syntax
import { uniqueIdentifier } from '@paunovic/utils'

// Importing specific function directly from the URL
import { uniqueIdentifier } from 'https://unpkg.com/@paunovic/utils'

// Importing specific function using CommonJS syntax
const { uniqueIdentifier } = require('@paunovic/utils')

Expand Down

0 comments on commit 5c81bc0

Please sign in to comment.