Update README & add license

Author: codegraphtheory

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Graph Technology Developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -1,50 +1,80 @@
 # Graph Technology Developers — Hub
 
-Static site powered by Eleventy (11ty), TypeScript (esbuild), and D3.js. The site delivers an SEO-friendly hub with a progressively-enhanced graph navigation experience.
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D22.0.0-brightgreen.svg)](https://nodejs.org/)
+[![npm](https://img.shields.io/badge/npm-%3E%3D10.0.0-blue.svg)](https://www.npmjs.com/)
+[![Built with Eleventy](https://img.shields.io/badge/Built%20with-Eleventy-blueviolet.svg)](https://www.11ty.dev/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue.svg)](https://www.typescriptlang.org/)
 
-## Prerequisites
+Static site powered by Eleventy (11ty), TypeScript (esbuild), and D3.js. The site delivers an SEO-friendly hub with a progressively-enhanced graph navigation experience.
 
-- Node.js 22+
-- npm 10+
+## Quick Start
 
-## Setup
+Get up and running in minutes:
 
 ```sh
+# Install dependencies
 npm install
-```
-
-## Development
 
-```sh
+# Start development server
 npm run dev
 ```
 
-- Runs esbuild in watch mode and Eleventy dev server at `http://localhost:8080`.
-- Source directories live in `src/`.
+Visit `http://localhost:8080` to see your local site. The dev server watches for changes and rebuilds automatically.
 
-## Build
+## Prerequisites
 
-```sh
-npm run build
-```
+- **Node.js** 22+ ([download](https://nodejs.org/))
+- **npm** 10+ (comes with Node.js)
 
-- Outputs static site to `dist/` for deployment.
+## Development Guide
 
-Preview the built site locally:
+### Project Structure
 
-```sh
-npm run preview
+```
+src/
+├── _data/          # Site metadata and configuration
+├── _includes/      # Nunjucks templates and partials
+├── assets/         # Static assets (icons, images)
+├── content/        # Markdown pages
+├── css/            # Stylesheets
+├── data/           # Graph data (nodes and links)
+└── js/             # TypeScript source files
 ```
 
-## Editing Content
+### Available Scripts
 
-- Homepage: `src/index.njk`
-- Markdown pages: `src/content/*.md`
-- Graph data: `src/data/graph.json`
-- CSS: `src/css/base.css`, `src/css/graph.css`
-- Scripts: `src/js/*.ts`
+| Command | Description |
+|---------|-------------|
+| `npm run dev` | Start development server with hot reload |
+| `npm run build` | Build production site to `dist/` |
+| `npm run preview` | Preview built site locally |
+| `npm run lint` | Type-check TypeScript files |
+| `npm run clean` | Remove build artifacts |
 
-### Adding Nodes or Links
+### Editing Content
+
+**Homepage**
+- Edit `src/index.njk` for the main page structure
+- Modify the hero section and CTA buttons here
+
+**Markdown Pages**
+- All `.md` files in `src/content/` become pages
+- Front matter controls metadata and layout
+
+**Graph Data**
+- Edit `src/data/graph.json` to add/remove nodes and links
+- Run `npm run build` after changes to regenerate the site
+
+**Styling**
+- `src/css/base.css` - Base styles and typography
+- `src/css/graph.css` - Graph-specific styles
+
+**TypeScript**
+- All scripts in `src/js/` are compiled via esbuild
+- Changes trigger rebuilds in watch mode
+
+### Adding Nodes or Links to the Graph
 
 Edit `src/data/graph.json`:
 
@@ -53,10 +83,10 @@ Edit `src/data/graph.json`:
   "nodes": [
     {
       "id": "unique-id",
-      "label": "Name",
+      "label": "Node Name",
       "type": "topic",
       "href": "/path/",
-      "description": "Short description.",
+      "description": "Short description for tooltips.",
       "tags": ["tag1", "tag2"],
       "pinned": false
     }
@@ -67,27 +97,48 @@ Edit `src/data/graph.json`:
 }
 ```
 
-After updates, run `npm run build` to regenerate the site.
+**Node Types:**
+- `hub` - Central navigation node
+- `topic` - Topic or category
+- `asset` - External resource or link
+
+**Link Kinds:**
+- `relates` - General relationship
+- `belongs` - Hierarchical relationship
+- `references` - Reference link
+
+After editing graph data, rebuild with `npm run build`.
 
 ## Deployment
 
-- GitHub Pages via `.github/workflows/pages.yml`
-- Custom domain `graphtech.dev` configured via `CNAME`
+This site is deployed to **GitHub Pages**:
 
-Push to `main` to trigger the Pages workflow.
+- Custom domain: `graphtech.dev` (configured via `CNAME`)
+- Push to `main` branch to trigger deployment
+- Built site output: `dist/`
 
-## Testing & Performance
+## Performance & Testing
 
-- Run Lighthouse against `dist/` or deployed site (target ≥ 90 mobile Perf/Accessibility).
-- JS bundle budget: ≤ 200KB gzipped (D3 + modules bundled via esbuild).
-- Prefers-reduced-motion respected by graph interactions.
+- **Lighthouse**: Target ≥ 90 mobile Performance/Accessibility
+- **Bundle Size**: JS bundle budget ≤ 200KB gzipped
+- **Accessibility**: Prefers-reduced-motion respected for graph interactions
 
 ## Analytics
 
-- Plausible (`data-domain="graphtech.dev"`) collects page views and custom events (`graph_node_hover`, `graph_node_click`, `graph_filter_used`).
+Plausible Analytics tracks:
+- Page views
+- Custom events: `graph_node_hover`, `graph_node_click`, `graph_filter_used`
+
+## Join the Community
+
+Connect with fellow graph technology developers:
+
+- **[Join the X Community](https://x.com/i/communities/1977449294861881612)** - Daily threads, pulses, and data drops. Share schemas, queries, datasets, and benchmarks.
+- **[Follow @codegraphtheory](https://github.com/codegraphtheory)** - Personal GitHub profile with educational resources and projects
+- **[Explore GraphTechnologyDevelopers](https://github.com/GraphTechnologyDevelopers)** - Organization hub for graph tech resources and templates
 
 ## License
 
-MIT
+MIT License - see [LICENSE](LICENSE) file for details.
 
 

package.json

@@ -20,7 +20,7 @@
   },
   "keywords": [],
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/GraphTechnologyDevelopers/graphtech.dev/issues"
   },