Skip to content

Commit a303d76

Browse files
committed
add readme
1 parent 8592792 commit a303d76

File tree

1 file changed

+64
-1
lines changed

1 file changed

+64
-1
lines changed

README.md

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,64 @@
1-
# context-tracker
1+
# Raycast Plugin: Context-Tracker
2+
3+
|| [Blog Post](https://open.substack.com/pub/ashwinmirskar/p/context-tracker-ai?r=b1eef&utm_campaign=post&utm_medium=web) || [Demo Video](https://youtu.be/CuOoXqdsD_w?si=nCknNQvhwroWAdGf) ||
4+
5+
## Overview
6+
7+
Context-Tracker is a Raycast plugin designed to help you track and manage your development contexts efficiently. It allows you to create, start, and end sessions, generate summaries, and keep track of session events. See [here](https://github.com/Pythonista7/context-tracker-backend) for the api server.
8+
9+
## Features
10+
11+
- **Create Contexts**: Easily create new contexts with a name and description.
12+
- **Start and End Sessions**: Start a new session within a context and end it when done.
13+
- **Session Events**: Track events that occur during a session.
14+
- **Generate Summaries**: Automatically generate summaries for your sessions.
15+
- **Quick Actions**: Access quick actions from the menu bar. (PS: Still a bit buggy.)
16+
17+
## Installation
18+
19+
1. Clone the repository:
20+
```sh
21+
git clone
22+
cd context-tracker
23+
```
24+
25+
2. Install dependencies:
26+
```sh
27+
npm install
28+
```
29+
30+
3. Build the project:
31+
```sh
32+
npm run build
33+
```
34+
35+
4. Start the development server:
36+
```sh
37+
npm run dev
38+
```
39+
40+
## Usage
41+
42+
### Creating a Context
43+
44+
1. Open the Raycast command palette.
45+
2. Select "New Context".
46+
3. Fill in the context name and description, then submit.
47+
48+
### Starting a Session
49+
50+
1. Open the Raycast command palette.
51+
2. Select a context from the list by double clicking on it to start recording.
52+
53+
### Generating a Summary
54+
55+
1. Open the Raycast command palette.
56+
2. Right Click on the currently "Recording" item and Select "Generate Summary".
57+
58+
### Ending a Session
59+
60+
1. Open the Raycast command palette.
61+
2. Right Click on the currently "Recording" item and Select "End Session".
62+
63+
## Contributing
64+
Contributions are welcome! Please open an issue or submit a pull request.

0 commit comments

Comments
 (0)