From d5cbd8d34a4354e35511de24c83e1f400ff1b598 Mon Sep 17 00:00:00 2001
From: elijahab <elijahab@venus.caltech.edu>
Date: Tue, 10 Mar 2026 14:59:05 -0700
Subject: [PATCH] First iteration of readme and repoo structure

---
 .pre-commit-config.yaml |  13 ------
 .readthedocs.yaml       |  16 -------
 LICENSE                 |   2 +-
 README.md               | 101 ++++++++++++++++++++++++++++++++++------
 4 files changed, 87 insertions(+), 45 deletions(-)
 delete mode 100644 .pre-commit-config.yaml
 delete mode 100644 .readthedocs.yaml

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
deleted file mode 100644
index cd89117..0000000
--- a/.pre-commit-config.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
-      - id: check-yaml
-  - repo: https://github.com/pycqa/ruff-pre-commit
-    rev: v0.6.9
-    hooks:
-      - id: ruff
-        args: [--fix]
-
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
deleted file mode 100644
index 4466d7f..0000000
--- a/.readthedocs.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-version: 2
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.12"
-  jobs:
-    pre_build:
-      - sphinx-apidoc -o docs/api src/your_project -f -e
-sphinx:
-  configuration: docs/conf.py
-python:
-  install:
-    - method: pip
-      path: .
-    - requirements: docs/requirements.txt
-
diff --git a/LICENSE b/LICENSE
index bce361a..a6ba36e 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [year] [fullname]
+Copyright (c) 2026 Elijah Anakalea-Buckley/Kupaianaha
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index 108210c..e97090f 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,91 @@
-# Read the Docs – Sphinx Template
+#  NAS-Setup
 
-A minimal template to spin up documentation quickly.
+> Configuration files, scripts, and documentation for setting up and managing a Network Attached Storage (NAS) system.
 
-## Use this template
+---
 
-1. Click **Use this template** on GitHub.
-2. Clone your new repo and rename placeholders:
+## Table of Contents
 
-   ```bash
-   export PKG=your_project      # snake_case python package directory
-   export DIST=your-project     # distribution/project name in pyproject
-   rg -l "your_project|your-project|Your Project|Your Name" | \
-     xargs sed -i '' \
-       -e "s/your_project/${PKG}/g" \
-       -e "s/your-project/${DIST}/g" \
-       -e "s/Your Project/${DIST}/g" \
-       -e "s/Your Name/Your Name Here/g"
-   git mv src/your_project src/${PKG}
+- [Overview](#overview)
+- [Hardware](#hardware)
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
 
+---
+
+## Overview
+
+A brief description of your NAS setup — what it's used for, who it's for, and any goals or design decisions behind it.
+
+---
+
+## Hardware
+
+| Component  | Details                  |
+|------------|--------------------------|
+| Board      | e.g. Raspberry Pi 4      |
+| CPU        | e.g. Quad-core ARM       |
+| RAM        | e.g. 8GB                 |
+| Storage    | e.g. 4x 4TB HDD (RAID 5) |
+| OS         | e.g. TrueNAS / OMV       |
+
+---
+
+## Prerequisites
+
+- [ ] List any software or tools required before setup
+- [ ] e.g. Docker, SSH access, specific OS version
+
+---
+
+## Installation
+
+```bash
+# Clone this repository
+git clone https://github.com/your-username/NAS-Setup.git
+cd NAS-Setup
+
+# Run setup script (if applicable)
+./setup.sh
+```
+
+---
+
+## Configuration
+
+Describe the main configuration steps or link to config files in the repo.
+
+```yaml
+# Example config snippet
+shares:
+  - name: media
+    path: /mnt/data/media
+    read_only: false
+```
+
+---
+
+## Usage
+
+Explain how to use the NAS once set up — accessing shares, running scripts, etc.
+
+```bash
+# Example: mount a share
+mount -t cifs //nas-ip/share /mnt/nas -o username=user
+```
+
+---
+
+## Contributing
+
+Pull requests are welcome! For major changes, please open an issue first to discuss what you'd like to change.
+
+---
+
+## License
+
+[MIT](LICENSE)