https://github.com/superwall/cursor-rules
https://github.com/superwall/cursor-rules
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/superwall/cursor-rules
- Owner: superwall
- Created: 2025-03-11T20:11:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-12T20:51:58.000Z (over 1 year ago)
- Last Synced: 2025-10-22T19:48:55.183Z (8 months ago)
- Size: 10.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Superwall Cursor Rules
This repository contains custom [Cursor Rules](https://docs.cursor.com/context/rules-for-ai) designed to enhance your development experience with [Superwall](https://superwall.com/docs/using-superwall-with-cursor). By adding these rules, Cursor AI can generate better code suggestions tailored to the Superwall SDK, making integration faster and more accurate.
Currently, this is available for iOS (Swift), with support for more SDKs and languages coming soon.
## 🚀 Getting Started
To set up Superwall-specific rules in Cursor:
1. Download the User Rule file for iOS from this repo: `ios-swiftui-cursor-rules-superwall-sdk.md`.
2. Open Cursor and navigate to **Cursor → Settings… → Cursor Settings**.
3. Under **User Rules**, paste the contents of the downloaded rule file.
## đź”— Combining with Existing Rules
You can append these rules to any existing Cursor rules you’re using. For example:
```markdown
[your existing rule]
[paste our Superwall rule below it]
```
For additional Cursor rules, check out [cursorrules.io](https://cursorrules.io).
## đź’ˇ Prompting Best Practices
To get the best results from Cursor, explicitly mention the Superwall SDK in your prompts.
âś… **Recommended:**
```md
Using the Superwall SDK, register a placement called "drinkCoffee" and include a print statement saying `Coffee time` in the block.
```
❌ **Less Effective:**
```md
Register a placement called "drinkCoffee" and include a print statement saying `Coffee time` in the block.
```
## đź”” Stay Updated
Superwall’s SDK evolves, and we’ll update these rules accordingly. **Watch** this repo for updates to ensure you always have the latest version.