Merge pull request #4 from Alokit-Innovations/akg/publish_readiness

Make VSCode Extension ready to be published

.gitignore

@@ -1 +1,2 @@
 **/node_modules
+.env

hustler/.vscodeignore → .vscodeignore

@@ -8,3 +8,4 @@ vsc-extension-quickstart.md
 **/*.map
 **/.eslintrc.json
 **/.vscode-test.*
+.env

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Change Log
+
+## [Unreleased]
+
+- Nothing yet
+
+## [0.0.2] - 2024-04-03
+
+### Added
+
+- Icon for the VSCode extension
+- Publisher name in package.json
+- SUPPORT.md and CONTRIBUTING.md files
+
+### Changed
+
+- CHANGELOG.md file updated with first two releases
+- Removed release notes from README.md because CHANGELOG file exists.
+
+## [0.0.1] - 2024-04-03
+
+- Initial release of the HustlerIDE extension based on [this post on X](https://twitter.com/AvikalpGupta/status/1775056328785858633)
+
+### Added
+
+- Command to remind the user to perform marketing or user research
+- Automatically trigger the command on a configurable interval
+- Options to snooze prompt for the day or disable completely
+- Configurable prompt interval from settings
+
+---
+---
+
+## HOW TO USE
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing to Hustler
+
+First off, thanks for taking the time to contribute!
+
+The following are guidelines to help you contribute to the Hustler extension.
+
+## Reporting Issues
+
+Before creating an issue, please search the [issue tracker](https://github.com/Alokit-Innovations/HustlerIDE/issues) to make sure it hasn't already been reported.
+
+When creating an issue, clearly describe the issue including steps to reproduce if applicable.
+
+## Suggesting Enhancements
+
+Enhancement suggestions are welcomed and encouraged!
+
+When creating an enhancement suggestion, explain the use case and how it will improve the extension for users.
+
+## Pull Requests
+
+Pull requests are greatly appreciated. To create one:
+
+1. Fork the repo and create your branch from `main`.
+2. Add your changes and corresponding tests, if applicable.
+3. Update the CHANGELOG.md with details of changes.
+4. Modify the documentation if creating new features.
+5. Make sure code lints and tests pass.
+
+Reviews may suggest changes. Be open to having your code improved during the review process.
+
+## Development Setup
+
+To develop the Hustler extension:
+
+1. Clone the repo
+2. Run `npm install`
+3. Open in Visual Studio Code
+4. Run/debug the extension

README.md

@@ -1,2 +1,48 @@
-# HustlerIDE
-IDE extension that randomly stops you and pops up a message "Hey, have you spent any time talking to customers or marketing this product today?"
+# Hustler IDE Extension
+This extension provides periodic prompts to remind you to reach out to customers and market your product.
+
+## Features
+
+![Prompt to talk to users](images/prompt.png)
+- Prompts user with marketing reminder
+- Options to snooze prompt for the day or disable completely
+- Configurable prompt interval from settings
+
+## Usage
+The prompt will automatically start displaying at the configured interval once the extension is installed.
+
+You can also use the command "Show prompt to talk to users" to manually trigger the prompt.
+
+> Tip: You can use the hotkeys Shift+Cmd+P (on MacOS) and Shift+Ctrl+P (on Windows and Linux) and type the command name to manually trigger the prompt.
+
+When the prompt appears, you can:
+- Click "Yes" to snooze prompts for the day
+- Click "Not Yet" to keep prompting at set interval
+- Click "Not Needed" to disable prompts
+
+## Extension Settings
+
+* `hustler.intervalDuration`: Set the duration between two prompts in seconds. We recommend setting this to the average duration of your focus sessions.
+
+This is set to 3600 seconds (1 hour) by default. To change:
+
+- Open Settings (Cmd+,)
+- Search for "Hustler"
+- Update "Interval Duration" with desired timing in seconds
+
+![Settings](images/setting.png)
+
+## Requirements
+
+Works on VSCode versions 1.87.0 and later.
+
+## Contributions
+Contributions are welcome! Please open issues and pull requests on [the GitHub repository](https://github.com/Alokit-Innovations/HustlerIDE).
+
+## License
+This extension is licensed under the [Apache v2.0](LICENSE).
+
+## Known Issues
+
+1. Currently, the extension is not able to remember its state across sessions. So you might see the prompts again on the same day after pressing "Yes" if you restart VSCode
+2. Project specific configuration is not supported yet. Pressing "Not Needed" will disable the prompts for all projects.

SUPPORT.md

@@ -0,0 +1,14 @@
+# SUPPORT
+
+## Getting Help
+
+If you have any issues or questions about the Hustler extension, here are some resources:
+
+- Documentation: [README](https://github.com/Alokit-Innovations/HustlerIDE/blob/main/README.md)
+- Bugs/Feature Requests: [Issues](https://github.com/Alokit-Innovations/HustlerIDE/issues)
+
+## Contributing
+
+If you would like to contribute to the Hustler extension, please refer to the [contribution guidelines](https://github.com/Alokit-Innovations/HustlerIDE/blob/main/CONTRIBUTING.md).
+
+Pull requests and feedback are welcome!

hustler/package.json → package.json

@@ -1,8 +1,14 @@
 {
   "name": "hustler",
   "displayName": "HustlerIDE",
+  "icon": "images/HustlerIDE128x128.png",
   "description": "Extension for side hustlers and indie hackers to remind them to talk to their users",
-  "version": "0.0.1",
+  "version": "0.0.2",
+  "publisher": "Vibinex",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alokit-Innovations/HustlerIDE.git"
+  },
   "engines": {
     "vscode": "^1.87.0"
   },