Initial implementation

.github/workflows/pages.yml

@@ -0,0 +1,31 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+    paths: [docs/**]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/configure-pages@v5
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

.npmignore

@@ -0,0 +1,4 @@
+src/
+tsconfig.json
+SPEC.md
+docs/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Getty Images
+Copyright (c) 2017-2026 Getty Images
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1 +1,40 @@
-# git-fi
+# git-fi
+
+A git plugin that maintains a temporary integration branch named `fi`. Merge multiple in-progress feature branches together to detect conflicts early and test features in collaboration — before they land on `main`.
+
+**[Documentation](https://gettyimages.github.io/git-fi/)** | **[Specification](SPEC.md)**
+
+## Install
+
+Requires Node.js >= 18 and git >= 2.50.0.
+
+```bash
+git clone https://github.com/gettyimages/git-fi.git
+cd git-fi
+npm install -g .   # or: yarn global add file:.
+```
+
+## Development
+
+```bash
+npm start -- -a my-branch   # run from source via tsx
+npm run build               # compile TypeScript to dist/
+```
+
+The implementation follows [SPEC.md](SPEC.md), which defines every requirement with a unique ID and includes mermaid diagrams for the major flows.
+
+## Project Structure
+
+```text
+SPEC.md        Behavioral specification
+src/           TypeScript implementation
+docs/          Docsify documentation site
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/gettyimages/git-fi/issues).
+
+## License
+
+[MIT](LICENSE) — Copyright (c) 2017-2026 Getty Images.