first commit
This commit is contained in:
72
README.md
Normal file
72
README.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# Thoughtful
|
||||
|
||||
A Raycast extension for quickly capturing ideas and opening your digital notebook.
|
||||
|
||||
## Features
|
||||
|
||||
- **Create Idea**: Quickly send ideas to your notebook via a configured API endpoint
|
||||
- **Open Thoughtful**: Open your Thoughtful app or notebook directly from Raycast
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone this repository
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
3. Run the extension in development mode:
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
When you first run the "Create Idea" command, you'll be prompted to configure:
|
||||
|
||||
- **URL**: The API endpoint where ideas will be sent
|
||||
- **Link**: The URL to open when using "Open Thoughtful" command
|
||||
- **Cookie**: Authentication cookie for API requests
|
||||
- **Custom Headers** (optional): Up to two custom headers for API authentication
|
||||
|
||||
Configuration is stored in `~/.thoughtful-config.json`.
|
||||
|
||||
## Commands
|
||||
|
||||
### Create Idea
|
||||
|
||||
Creates a new idea in your notebook. The extension:
|
||||
1. Prompts you for configuration on first use
|
||||
2. Provides a form to enter your idea
|
||||
3. Sends the idea to your configured API endpoint
|
||||
4. Shows the response from your notebook
|
||||
|
||||
### Open Thoughtful
|
||||
|
||||
Opens your Thoughtful app or notebook in the default browser. Uses the link configured in the "Create Idea" command.
|
||||
|
||||
## Development
|
||||
|
||||
This extension is built with:
|
||||
- [Raycast API](https://developers.raycast.com/)
|
||||
- TypeScript
|
||||
- React
|
||||
|
||||
### Scripts
|
||||
|
||||
- `pnpm dev` - Run extension in development mode
|
||||
- `pnpm build` - Build the extension for production
|
||||
- `pnpm lint` - Lint the code
|
||||
- `pnpm fix-lint` - Fix linting issues
|
||||
- `pnpm publish` - Publish to Raycast Store
|
||||
|
||||
## Platform Support
|
||||
|
||||
- Windows
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
## Author
|
||||
|
||||
thoughtful
|
||||
Reference in New Issue
Block a user