Skip to content

Commit

Permalink
link readmes, add placehodler for missing reads
Browse files Browse the repository at this point in the history
  • Loading branch information
brandon-schabel committed Oct 24, 2023
1 parent 412c928 commit 7a00705
Show file tree
Hide file tree
Showing 14 changed files with 48 additions and 35 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,35 +84,38 @@ 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: 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](modules/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.

2. Cookie: 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. [Cookie](modules/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.

3. Data Gen: 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]("modules/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.

4. Deploy: 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]("modules/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.

5. Fetcher: 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]("modules/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.

6. Files Folder: 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]("modules/files-folders/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.

7. Hash: The Hash module provides a simple abstraction to Bun's hashing functions. It allows you to hash data using common hashing algorithms for tasks such as password hashing or data integrity checks.
7. [Hash]("modules/hash/README.md): The Hash module provides a simple abstraction to Bun's hashing functions. It allows you to hash data using common hashing algorithms for tasks such as password hashing or data integrity checks.

8. JWT: 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.
8. [JWT]("modules/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. Logger: 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.
9. [Logger]("modules/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. NPM 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.
10. [NPM]("modules/npm/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. Server: 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 type safety integration with the Fetcher module.
11. [Server]("modules/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 type safety integration with the Fetcher module.

12. SQLite: 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.
12. [SQLite]("modules/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. State Management: 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.
13. [State Management]("modules/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. Utils: 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.
14. [Utils]("modules/utils/README"): 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. [UUID]("modules/uuid/README.md"): Generate timestamp encoded UUIDs with UUIDv7 spec implemented

16. [Type Utils]("modules/type-utils.md"): TypeScript Utilities

15. UUID: Generate timestamp encoded UUIDs with UUIDv7 spec implemented

```typescript
import * as u from '@bnk/core'
Expand Down
4 changes: 2 additions & 2 deletions modules/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# README: cli-factory
# CLI Module

## Overview

Expand Down Expand Up @@ -65,4 +65,4 @@ cli.handleFiles({
## Note

- Ensure that you have the necessary permissions to interact with the file system when handling files.
- Always validate user inputs and handle potential errors to prevent unwanted operations.
- Always validate user inputs and handle potential errors to prevent unwanted operations.
28 changes: 14 additions & 14 deletions modules/cookies/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Combined Cookie Factory README
# Cookies Factory README

## Overview

The **Cookie Factory** provides utility functions to manage cookies on both the client and server sides. This all-encompassing module allows for easy setting, getting, deleting, and checking the existence of cookies in various contexts.

## Table of Contents

- [Combined Cookie Factory README](#combined-cookie-factory-readme)
- [Cookies Factory README](#cookies-factory-readme)
- [Overview](#overview)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Client-Side Usage](#client-side-usage)
- [Server-Side Usage](#server-side-usage)
- [Client-Side 🍪 Usage](#client-side--usage)
- [Server-Side 🍪 Usage](#server-side--usage)
- [API](#api)
- [Client-Side API](#client-side-api)
- [Server-Side API](#server-side-api)
- [Client-Side 🍪 API](#client-side--api)
- [Server-Side 🍪 API](#server-side--api)
- [Testing](#testing)
- [Full Stack Implementation Example](#full-stack-implementation-example)
- [Full Stack 🍪 Implementation Example](#full-stack--implementation-example)

## Installation

1. Copy the `cookie-factory.ts` (combined client and server functionality) to your source directory.
2. Import the module using the appropriate import syntax:
1🍪 Copy the `cookie-factory.ts` (combined client and server functionality) to your source directory.
2🍪 Import the module using the appropriate import syntax:

```typescript
import {
Expand All @@ -30,7 +30,7 @@ import {
} from "./path-to/cookie-factory";
```

## Client-Side Usage
## Client-Side 🍪 Usage

First, create an instance of the client-side cookie factory:

Expand All @@ -40,7 +40,7 @@ const clientCookieFactory = createClientCookieFactory();

Then, use the methods provided by the factory to manipulate cookies.

## Server-Side Usage
## Server-Side 🍪 Usage

Similarly, initialize the server-side cookie factory:

Expand All @@ -52,14 +52,14 @@ Utilize the provided methods to manage server-side cookies.

## API

### Client-Side API
### Client-Side 🍪 API

- **setCookie(name: string, value: string, options: CookieOptions = {})**: Sets a cookie.
- **getCookie(name: string)**: Retrieves the value of a specific cookie.
- **deleteCookie(name: string)**: Deletes a cookie.
- **checkCookie(name: string)**: Checks the existence of a cookie.

### Server-Side API
### Server-Side 🍪 API

- **setCookie(res: Response, name: string, value: string, options?: CookieOptions)**: Sets a cookie on the server's response object.
- **getCookie(req: Request, name: string)**: Retrieves a cookie's value from the server's request object.
Expand All @@ -72,7 +72,7 @@ Utilize the provided methods to manage server-side cookies.

- Server-side: The module comes with server-side tests using the `bun:test` library.

## Full Stack Implementation Example
## Full Stack 🍪 Implementation Example

```typescript
// Client
Expand Down
1 change: 1 addition & 0 deletions modules/deploy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Deploy
1 change: 1 addition & 0 deletions modules/fetcher/READMEd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Fetcher
1 change: 1 addition & 0 deletions modules/files-folders/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Files And Folder Utilities
3 changes: 3 additions & 0 deletions modules/hash/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hash Module

Since Bun has great built in hashing this will like ly be rolled into a later planned auth module
1 change: 0 additions & 1 deletion modules/hash/hash-factory.md

This file was deleted.

3 changes: 2 additions & 1 deletion modules/htmlody/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,5 @@ export type {
MDNode
} from "./htmlody-plugins";

export { uClass } from "./css-engine";
export { cc, uClass } from "./css-engine";

1 change: 1 addition & 0 deletions modules/logger/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Logger Module
4 changes: 2 additions & 2 deletions modules/npm-release/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# README: npm-release-factory
# NPM Release Module Readme

## Overview

Expand Down Expand Up @@ -77,4 +77,4 @@ await releaseUtils.npmPublish({
## Note

- Ensure that you have the required permissions to publish to the npm registry.
- Always double-check the versions and configurations before publishing to avoid potential conflicts or unwanted changes.
- Always double-check the versions and configurations before publishing to avoid potential conflicts or unwanted changes.
1 change: 1 addition & 0 deletions modules/test-utils/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Test Utils
1 change: 1 addition & 0 deletions modules/utils/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Utils
1 change: 1 addition & 0 deletions modules/uuid/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# UUID

0 comments on commit 7a00705

Please sign in to comment.