Skip to content

Commit 2fec9c4

Browse files
mnriemCopilot
andcommitted
fix: revert README and installation docs to match main
Do not mention PyPI in documentation until the first official PyPI release has been published. This PR only adds the workflow and readme metadata in pyproject.toml. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d6460dd commit 2fec9c4

2 files changed

Lines changed: 13 additions & 25 deletions

File tree

README.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img src="https://raw.githubusercontent.com/github/spec-kit/main/media/logo_large.webp" alt="Spec Kit Logo" width="200" height="200"/>
2+
<img src="./media/logo_large.webp" alt="Spec Kit Logo" width="200" height="200"/>
33
<h1>🌱 Spec Kit</h1>
44
<h3><em>Build high-quality software faster.</em></h3>
55
</div>
@@ -45,19 +45,13 @@ Spec-Driven Development **flips the script** on traditional software development
4545

4646
### 1. Install Specify CLI
4747

48-
Requires **[uv](https://docs.astral.sh/uv/)** ([install uv](https://github.com/github/spec-kit/blob/main/docs/install/uv.md)). Replace `vX.Y.Z` with the latest tag from [Releases](https://github.com/github/spec-kit/releases):
48+
Requires **[uv](https://docs.astral.sh/uv/)** ([install uv](./docs/install/uv.md)). Replace `vX.Y.Z` with the latest tag from [Releases](https://github.com/github/spec-kit/releases):
4949

5050
```bash
5151
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z
5252
```
5353

54-
Or install from [PyPI](https://pypi.org/project/specify-cli/) (once published for a new release):
55-
56-
```bash
57-
uv tool install specify-cli@latest
58-
```
59-
60-
See the [Installation Guide](https://github.com/github/spec-kit/blob/main/docs/installation.md) for alternative methods, verification, upgrade, and troubleshooting.
54+
See the [Installation Guide](./docs/installation.md) for alternative methods, verification, upgrade, and troubleshooting.
6155

6256
### 2. Initialize a project
6357

@@ -66,7 +60,7 @@ specify init my-project --integration copilot
6660
cd my-project
6761
```
6862

69-
To check for updates or upgrade the installed CLI, use the self-management commands. See the [Upgrade Guide](https://github.com/github/spec-kit/blob/main/docs/upgrade.md) for detailed scenarios and customization options.
63+
To check for updates or upgrade the installed CLI, use the self-management commands. See the [Upgrade Guide](./docs/upgrade.md) for detailed scenarios and customization options.
7064

7165
```bash
7266
# Check whether a newer release is available (read-only — does not modify anything)
@@ -126,13 +120,13 @@ Use **`/speckit.implement`** to execute all tasks and build your feature accordi
126120
/speckit.implement
127121
```
128122

129-
For detailed step-by-step instructions, see our [comprehensive guide](https://github.com/github/spec-kit/blob/main/spec-driven.md).
123+
For detailed step-by-step instructions, see our [comprehensive guide](./spec-driven.md).
130124

131125
## 📽️ Video Overview
132126

133127
Want to see Spec Kit in action? Watch our [video overview](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)!
134128

135-
[![Spec Kit video header](https://raw.githubusercontent.com/github/spec-kit/main/media/spec-kit-video-header.jpg)](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)
129+
[![Spec Kit video header](/media/spec-kit-video-header.jpg)](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)
136130

137131
## 🌍 Community
138132

@@ -316,7 +310,7 @@ Spec-Driven Development is a structured process that emphasizes:
316310
For existing projects, keep Spec Kit tooling updates separate from feature
317311
artifact evolution: refresh managed project files when upgrading, and update
318312
`specs/` artifacts when intended behavior changes. The
319-
[Evolving Specs guide](https://github.com/github/spec-kit/blob/main/docs/guides/evolving-specs.md) describes the
313+
[Evolving Specs guide](./docs/guides/evolving-specs.md) describes the
320314
recommended brownfield loop.
321315

322316
## 🎯 Experimental Goals
@@ -357,7 +351,7 @@ If you encounter issues with an agent, please open an issue so we can refine the
357351

358352
## 📖 Learn More
359353

360-
- **[Complete Spec-Driven Development Methodology](https://github.com/github/spec-kit/blob/main/spec-driven.md)** - Deep dive into the full process
354+
- **[Complete Spec-Driven Development Methodology](./spec-driven.md)** - Deep dive into the full process
361355
- **[Detailed Walkthrough](#-detailed-process)** - Step-by-step implementation guide
362356

363357
---
@@ -385,7 +379,7 @@ specify init . --force
385379
specify init --here --force
386380
```
387381

388-
![Specify CLI bootstrapping a new project in the terminal](https://raw.githubusercontent.com/github/spec-kit/main/media/specify_cli.gif)
382+
![Specify CLI bootstrapping a new project in the terminal](./media/specify_cli.gif)
389383

390384
In an interactive terminal, you will be prompted to select the coding agent integration you are using. In non-interactive sessions, such as CI or piped runs, `specify init` defaults to GitHub Copilot unless you pass `--integration`. You can also proactively specify the integration directly in the terminal:
391385

@@ -419,7 +413,7 @@ specify init <project_name> --integration copilot --ignore-agent-tools
419413

420414
Go to the project folder and run your coding agent. In our example, we're using `claude`.
421415

422-
![Bootstrapping Claude Code environment](https://raw.githubusercontent.com/github/spec-kit/main/media/bootstrap-claude-code.gif)
416+
![Bootstrapping Claude Code environment](./media/bootstrap-claude-code.gif)
423417

424418
You will know that things are configured correctly if you see the `/speckit.constitution`, `/speckit.specify`, `/speckit.plan`, `/speckit.tasks`, and `/speckit.implement` commands available.
425419

@@ -659,4 +653,4 @@ This project is heavily influenced by and based on the work and research of [Joh
659653

660654
## 📄 License
661655

662-
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](https://github.com/github/spec-kit/blob/main/LICENSE) file for the full terms.
656+
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.

docs/installation.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
## Installation
1212

13-
> [!NOTE]
14-
> The `specify-cli` package will also be available on [PyPI](https://pypi.org/project/specify-cli/) once official publishing is enabled. Source installs from the GitHub repository are always available immediately.
13+
> [!IMPORTANT]
14+
> The only official, maintained packages for Spec Kit come from the [github/spec-kit](https://github.com/github/spec-kit) GitHub repository. Any packages with the same name available on PyPI (e.g. `specify-cli` on pypi.org) are **not** affiliated with this project and are not maintained by the Spec Kit maintainers. For normal installs, use the GitHub-based commands shown below. For offline or air-gapped environments, locally built wheels created from this repository are also valid.
1515
1616
### Persistent Installation (Recommended)
1717

@@ -24,12 +24,6 @@ Install once and use everywhere. Replace `vX.Y.Z` with a tag from [Releases](htt
2424
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z
2525
```
2626

27-
Or, once official PyPI publishing is enabled, install from PyPI:
28-
29-
```bash
30-
uv tool install specify-cli@latest
31-
```
32-
3327
Then initialize a project:
3428

3529
```bash

0 commit comments

Comments
 (0)