Skip to content

Commit

Permalink
updated doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
@brandon-schabel
brandon-schabel committed Nov 15, 2023
1 parent 997c7b3 commit 919e6de
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,37 +87,37 @@ Join our [Discord Server]("https://discord.gg/rQyWN7V6"), drop in and ask questi

Bun Nook Kit offers a wide array of utility modules including:

1. [🖥️CLI](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/CLI-README.md): The CLI module aims to provide a simple way to build a basic command-line interface for tasks such as project scaffolding or generating configurations. It helps you handle command-line input, parse arguments, and interact with the file system.
1. [🖥️CLI](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/cli.md): The CLI module aims to provide a simple way to build a basic command-line interface for tasks such as project scaffolding or generating configurations. It helps you handle command-line input, parse arguments, and interact with the file system.

2. [🍪Cookies](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/COOKIES-README.md): The Cookie module provides utilities for handling cookies on both the client-side and server-side. It allows you to set, get, and delete cookies, as well as manage cookie options such as expiration and domain.
2. [🍪Cookies](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/cookie.md): The Cookie module provides utilities for handling cookies on both the client-side and server-side. It allows you to set, get, and delete cookies, as well as manage cookie options such as expiration and domain.

3. [💿Data Gen](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/DATA-GEN-README.md): The Data Gen module is a simple data generator that allows you to create mock data for testing purposes. While it may not replace more robust data generation tools, it provides a quick and easy way to generate sample data.
3. [💿Data Gen](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/data-gen.md): The Data Gen module is a simple data generator that allows you to create mock data for testing purposes. While it may not replace more robust data generation tools, it provides a quick and easy way to generate sample data.

4. [🏗️Deploy](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/DEPLOY-README.md): The Deploy module provides utilities for deployment, with a focus on GitHub Actions integration. It helps you automate the deployment process for your Bun Nook Kit package.
4. [🏗️Deploy](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/deply.md): The Deploy module provides utilities for deployment, with a focus on GitHub Actions integration. It helps you automate the deployment process for your Bun Nook Kit package.

5. [🐶🦴Fetcher](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/FETCHER-README.md): The Fetcher module enhances the standard fetch function provided by Bun. It allows you to configure an entire API and provides a TypeScript interface for easy integration with your project. The Fetcher module helps you make HTTP requests and handles data fetching and updating.
5. [🐶🦴Fetcher](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/fetcher.md): The Fetcher module enhances the standard fetch function provided by Bun. It allows you to configure an entire API and provides a TypeScript interface for easy integration with your project. The Fetcher module helps you make HTTP requests and handles data fetching and updating.

6. [📂Files Folder](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/FILES-FOLDER-README.md): The Files Folder module provides various utilities for working with files and folders. It includes functions for searching for files, validating file paths, and creating references to files. This module can be useful for tasks like building an in-browser file manager.
6. [📂Files Folder](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/files-folder.md): The Files Folder module provides various utilities for working with files and folders. It includes functions for searching for files, validating file paths, and creating references to files. This module can be useful for tasks like building an in-browser file manager.

7. [🔐Auth](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/AUTH-README.md): The auth module provides offers utilities for encryption of passwords/data.
7. [🔐Auth](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/auth.md): The auth module provides offers utilities for encryption of passwords/data.

8. [📜HTMLody](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/HTMLODY-README.md): HTMLody is a tool that enables the conversion of JSON structures into valid HTML and CSS, facilitating both dynamic HTML generation and the export of static assets for enhanced web performance. It offers a flexible and maintainable approach to web development, with support for plugins with prebuilt plugins such as Tailwind-like CSS class utilties and a render Markdown plugin utility, easily integrate with libraries like HTMX for dynamic functionality, and a comprehensive TypeScript support for defining and customizing the JSON elements.
8. [📜HTMLody](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/htmlody.md): HTMLody is a tool that enables the conversion of JSON structures into valid HTML and CSS, facilitating both dynamic HTML generation and the export of static assets for enhanced web performance. It offers a flexible and maintainable approach to web development, with support for plugins with prebuilt plugins such as Tailwind-like CSS class utilties and a render Markdown plugin utility, easily integrate with libraries like HTMX for dynamic functionality, and a comprehensive TypeScript support for defining and customizing the JSON elements.

9. [🔎JWT](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/JWT-README.md): The JWT module provides utilities for working with JSON Web Tokens. It allows you to encode and decode JWTs and provides features like token invalidation.
9. [🔎JWT](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/jwt.md): The JWT module provides utilities for working with JSON Web Tokens. It allows you to encode and decode JWTs and provides features like token invalidation.

10. [🪵Logger](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/LOGGER-README.md): The Logger module aims to provide a full-featured logging system for your application. While it is still under development and might be limited in functionality, it can be a useful tool for debugging and error tracking.
10. [🪵Logger](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/logger.md): The Logger module aims to provide a full-featured logging system for your application. While it is still under development and might be limited in functionality, it can be a useful tool for debugging and error tracking.

11. [📦NPM](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/NPM-RELEASE-README.md) Release: The NPM Release module provides utilities for managing NPM packages. It allows you to update the package version, retrieve the package version, and set up npm authentication. This module can be used in conjunction with the Deploy module for publishing NPM packages
11. [📦NPM](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/npm-release.md) Release: The NPM Release module provides utilities for managing NPM packages. It allows you to update the package version, retrieve the package version, and set up npm authentication. This module can be used in conjunction with the Deploy module for publishing NPM packages

12. [🌎Server](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/SERVER-README.md): The Server module is one of the most complex modules in Bun Nook Kit. It helps you set up an HTTP server with various middleware options. It simplifies tasks like handling CORS and provides a TypeScript interface for type-safe request handlers. The goal is to provide seamless andtype safe server configurations.
12. [🌎Server](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/server.md): The Server module is one of the most complex modules in Bun Nook Kit. It helps you set up an HTTP server with various middleware options. It simplifies tasks like handling CORS and provides a TypeScript interface for type-safe request handlers. The goal is to provide seamless andtype safe server configurations.

13. [📝SQLite](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/SQLITE-README.md): The SQLite module builds on top of Bun's SQLite implementation and provides utilities for working with SQLite databases. It includes functions for instantiating databases, creating type-safe schemas, and performing database operations.
13. [📝SQLite](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/sqlite.md): The SQLite module builds on top of Bun's SQLite implementation and provides utilities for working with SQLite databases. It includes functions for instantiating databases, creating type-safe schemas, and performing database operations.

14. [🔄State Management](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/STATE-README.md) : The State Management module provides an interface for building type-safe state managers. It offers an immutable state management approach and includes dispatcher functions for easy data manipulation. The module also provides a WebSocket state manager for syncing data between the client and server.
14. [🔄State Management](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/state.md) : The State Management module provides an interface for building type-safe state managers. It offers an immutable state management approach and includes dispatcher functions for easy data manipulation. The module also provides a WebSocket state manager for syncing data between the client and server.

15. [🛠️Utils](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/UTILS-README.md): This isn't really a module :) - it does contains various utility functions that can be used across different modules. It includes functions like classy for generating class names, normalizeBytes for converting byte numbers to formatted text, and value checkers for inferring data types.
15. [🛠️Utils](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/utils.md): This isn't really a module :) - it does contains various utility functions that can be used across different modules. It includes functions like classy for generating class names, normalizeBytes for converting byte numbers to formatted text, and value checkers for inferring data types.

16. [🆔UUID](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/UUID-README.md): Generate timestamp encoded UUIDs with UUIDv7 spec implemented
16. [🆔UUID](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/uuid.md): Generate timestamp encoded UUIDs with UUIDv7 spec implemented

17. [🧙‍♂️Type Utils](https://github.com/brandon-schabel/bun-nook-kit-docs/readmes/type-utils.md): TypeScript Utilities

Expand Down

0 comments on commit 919e6de

Please sign in to comment.