phil/StarPunk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update README to v0.9.5 with architect-approved corrections

Browse Source 
- Update version to 0.9.5 throughout README
- Clarify Micropub as coming in v1.0 (currently in development)
- Add note that database auto-initializes on first run
- Fix deployment documentation link to standards location
- Add .gitignore entry for test.ini temporary file

All changes approved by architect agent.

Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Phil Skentelbery
2025-11-24 12:21:09 -07:00
parent e2333cb31d
commit 4b0ac627e5
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -58,6 +58,7 @@ htmlcov/
.hypothesis/ .hypothesis/
.tox/ .tox/
.nox/ .nox/
test.ini
# Logs # Logs
*.log *.log

12
README.md
View File

@@ -2,16 +2,17 @@
A minimal, self-hosted IndieWeb CMS for publishing notes with RSS syndication. A minimal, self-hosted IndieWeb CMS for publishing notes with RSS syndication.
**Current Version**: 0.1.0 (development) **Current Version**: 0.9.5 (development)
## Versioning ## Versioning
StarPunk follows [Semantic Versioning 2.0.0](https://semver.org/): StarPunk follows [Semantic Versioning 2.0.0](https://semver.org/):
- Version format: `MAJOR.MINOR.PATCH` - Version format: `MAJOR.MINOR.PATCH`
- Current: `0.1.0` (pre-release development) - Current: `0.9.5` (pre-release development)
- First stable release will be `1.0.0` - First stable release will be `1.0.0`
**Version Information**: **Version Information**:
- Current: `0.9.5` (pre-release development)
- Check version: `python -c "from starpunk import __version__; print(__version__)"` - Check version: `python -c "from starpunk import __version__; print(__version__)"`
- See changes: [CHANGELOG.md](CHANGELOG.md) - See changes: [CHANGELOG.md](CHANGELOG.md)
- Versioning strategy: [docs/standards/versioning-strategy.md](docs/standards/versioning-strategy.md) - Versioning strategy: [docs/standards/versioning-strategy.md](docs/standards/versioning-strategy.md)
@@ -31,7 +32,7 @@ StarPunk is designed for a single user who wants to:
- **File-based storage**: Notes are markdown files, owned by you - **File-based storage**: Notes are markdown files, owned by you
- **IndieAuth authentication**: Use your own website as identity - **IndieAuth authentication**: Use your own website as identity
- **Micropub support**: Publish from any Micropub client - **Micropub support**: Coming in v1.0 (currently in development)
- **RSS feed**: Automatic syndication - **RSS feed**: Automatic syndication
- **No database lock-in**: SQLite for metadata, files for content - **No database lock-in**: SQLite for metadata, files for content
- **Self-hostable**: Run on your own server - **Self-hostable**: Run on your own server
@@ -66,6 +67,7 @@ cp .env.example .env
# Initialize database # Initialize database
mkdir -p data/notes mkdir -p data/notes
.venv/bin/python -c "from starpunk.database import init_db; init_db()" .venv/bin/python -c "from starpunk.database import init_db; init_db()"
# Note: Database also auto-initializes on first run if not present
# Run development server # Run development server
.venv/bin/flask --app app.py run --debug .venv/bin/flask --app app.py run --debug
@@ -106,7 +108,7 @@ starpunk/
2. Login with your IndieWeb identity 2. Login with your IndieWeb identity
3. Create notes in markdown 3. Create notes in markdown
**Via Micropub Client**: **Via Micropub Client** (Coming in v1.0):
1. Configure client with your site URL 1. Configure client with your site URL
2. Authenticate via IndieAuth 2. Authenticate via IndieAuth
3. Publish from any Micropub-compatible app 3. Publish from any Micropub-compatible app
@@ -175,7 +177,7 @@ uv pip install gunicorn
# Enable regular backups of data/ directory # Enable regular backups of data/ directory
``` ```
See [docs/architecture/deployment.md](docs/architecture/deployment.md) for details. See [docs/standards/deployment-standards.md](docs/standards/deployment-standards.md) for details.
## License ## License