Skip to content

Commit

Permalink
add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
potatoqualitee committed Jan 4, 2025
1 parent 8b6cbf7 commit f90aaa6
Showing 1 changed file with 86 additions and 13 deletions.
99 changes: 86 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,106 @@
# Mutesky - Bulk manage Bluesky mutes with pre-populated keyword lists
# MuteSky - Bulk manage Bluesky mutes with pre-populated keyword lists

<img align="left" src="images/logo.png" alt="Mutesky Logo" width="245" height="177" style="margin-right: 20px"> Mutesky is a web app that gives you granular control over what appears in your Bluesky feed through curated keyword collections. Working directly with Bluesky's native mute system, it provides an intuitive interface to filter out content you'd rather not see. With over 1,400 pre-populated keywords organized into 20+ smart categories, Mutesky makes content filtering both easy and effective.
<img align="left" src="images/logo.png" alt="Mutesky Logo" width="245" height="177" style="margin-right: 20px"> MuteSky is a web app that gives you granular control over what appears in your Bluesky feed through curated keyword collections. Working directly with Bluesky's native mute system, it provides an intuitive interface to filter out content you'd rather not see. With over 1,400 pre-populated keywords organized into 20+ smart categories, MuteSky makes content filtering both easy and effective.

&nbsp;

## Key Features

- **Instant Setup**: Pre-populated with 1,400+ keywords
- **Smart Categories**: 20+ organized topic groups from politics to climate
## 🌟 Key Features

- **Instant Setup**: Pre-populated with 1,400+ keywords, continuously updated by AI to reflect current events
- **Smart Categories**: 20+ organized topic groups covering:
- Political Discord
- Violence & Security
- Social Issues
- Global Affairs
- Healthcare
- Economy
- Environment
- Religion
- New Developments
- **Two Ways to Filter**:
- Simple Mode: Quick topic-based filtering
- Simple Mode: Quick topic-based filtering with 4 strength levels
- Advanced Mode: Fine-tune individual keywords
- **Smart Search**: Filter keywords to find related terms, then enable/disable them all at once or individually
- **Real-Time**: Changes hit your feed instantly
- **Zero Storage**: Works directly with Bluesky's mute system - we never store your data
- **Performance Optimized**: Smart warnings when approaching Bluesky's performance thresholds

## 🖼️ Screenshots

### Simple Mode
<div style="display: flex; gap: 10px;">
<img src="images/screenshots/light-simple-mode.png" alt="Light Simple Mode" width="400">
<img src="images/screenshots/dark-simple-mode.png" alt="Dark Simple Mode" width="400">
</div>

### Advanced Mode
<div style="display: flex; gap: 10px;">
<img src="images/screenshots/light-advanced-mode.png" alt="Light Advanced Mode" width="400">
<img src="images/screenshots/dark-advanced-mode.png" alt="Dark Advanced Mode" width="400">
</div>

## Get Started
### Smart Search
<div style="display: flex; gap: 10px;">
<img src="images/screenshots/light-search.png" alt="Light Search" width="400">
<img src="images/screenshots/dark-search.png" alt="Dark Search" width="400">
</div>

## 🚀 Get Started

1. Visit [mutesky.app](https://mutesky.app)
2. Sign in with your Bluesky account (ex. username.bsky.social)
3. Pick your topics or dive into keyword management
4. Click "Mute" to apply changes

## Made With
## 📚 Documentation

Comprehensive documentation is available in the [docs](docs/README.md) directory:

### User Guides
- [Understanding Modes](docs/3-guides/1-understanding-modes.md) - Learn when to use Simple vs Advanced mode
- [Muting Explained](docs/3-guides/2-muting-explained.md) - How muting works with Bluesky
- [State Persistence](docs/3-guides/3-state-persistence.md) - Understanding saved changes

- Frontend: Vanilla JS, HTML, CSS
### Architecture
- [Core Concepts](docs/1-architecture/1-core-concepts.md) - System overview and state management
- [Authentication](docs/1-architecture/2-authentication.md) - OAuth and session handling
- [Muting System](docs/1-architecture/3-muting-system.md) - Keyword management and API integration
- [Mode System](docs/1-architecture/4-mode-system.md) - Simple/Advanced mode implementation
- [Performance](docs/1-architecture/5-performance.md) - Core optimizations
- [Click Performance](docs/1-architecture/6-click-performance.md) - UI responsiveness

### Development
- [Known Issues](docs/2-development/1-known-issues.md) - Common problems and solutions
- [Troubleshooting Guide](docs/2-development/2-troubleshooting-guide.md) - Debug common issues

## 👩‍💻 Developer Quick Start

### Tech Stack
- Frontend: Vanilla JavaScript with Web Components
- Integration: Bluesky/ATP API
- Deployment: GitHub Pages
- Build: Webpack

## Local Development
### Key Technical Features
1. **State Management**:
- Centralized state object
- Local storage persistence
- Error recovery system
- Event-driven updates

2. **Performance Optimization**:
- Critical CSS loading
- Debounced updates
- Cached calculations
- Smart keyword thresholds

3. **Security & Privacy**:
- Direct Bluesky auth integration
- Zero data storage
- Secure credential handling
- Non-destructive operations

### Local Development

```bash
# Install dependencies
Expand All @@ -42,10 +113,12 @@ npm run dev
npm run build
```

## Related Projects
## 🔗 Related Projects

Check out [US Politician Labeler](https://bsky.app/profile/did:plc:bxnuth7kms5l57v2milp5gb3)

## Coming Soon
And the [Calm the Chaos Browser extension](https://chromewebstore.google.com/detail/calm-the-chaos/cholkigafekgccbkfgcmcigihipbnjoe?authuser=0&hl=en)

## 🔮 Coming Soon

AI-powered dynamic keyword updates: An optional service that automatically identifies and updates mute keywords hourly based on emerging trends and topics.

0 comments on commit f90aaa6

Please sign in to comment.