Merge pull request #37 from rishi255/develop

🔖 v1.0 is here!

.github/workflows/main.yml

@@ -22,7 +22,7 @@ jobs:
           # All of these options are optional, so you can remove them if you are happy with the defaults
           concurrent_skipping: "never"
           skip_after_successful_duplicate: "false"
-          paths_ignore: '["**.md", ".gitignore", ".prettierrc", "**/Docs/**"]'
+          paths_ignore: '["**.md", ".gitignore", ".prettierrc", "**/Docs/**", "assets/**", "**.yml"]'
           do_not_skip: '["workflow_dispatch", "schedule"]'
 
   # 1st Job -- Building the module, skip job if should_skip is true

.gitignore

@@ -1,4 +1,6 @@
-shared_with_containers_dir
+shared_with_containers_dir/
+assets_archived/
+terminalizer_config/
 
 # Environments
 .env

PoshCodex/Docs/Set-CompletionKeybind.md

@@ -47,6 +47,7 @@ PS C:\> Set-CompletionKeybind 'Ctrl+K,Ctrl+E'
 ## PARAMETERS
 
 ### -new_keybind
+
 {{ Fill new_keybind Description }}
 
 ```yaml
@@ -62,6 +63,7 @@ Accept wildcard characters: False
 ```
 
 ### -old_keybind
+
 {{ Fill old_keybind Description }}
 
 ```yaml
@@ -93,6 +95,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
+
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS

PoshCodex/Source/PoshCodex.psd1

@@ -12,7 +12,7 @@
 # RootModule = ''
 
 # Version number of this module.
-ModuleVersion = '0.6.5'
+ModuleVersion = '1.0.1'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

README.md

@@ -47,15 +47,15 @@
   </a>
   <a href="https://github.com/rishi255/posh_codex">
     <img
-      src="https://img.shields.io/github/workflow/status/rishi255/posh_codex/Build%20and%20Publish%20Module?colorA=2c2837&style=for-the-badge"
+      src="https://img.shields.io/github/actions/workflow/status/rishi255/posh_codex/main.yml?branch=main&colorA=2c2837&style=for-the-badge"
       alt="GitHub Workflow build status"
     />
   </a>
 </div>
 <br/>
 <div align="center">
   <img
-    src="https://raw.githubusercontent.com/tom-doerr/bins/main/zsh_codex/zc4.gif"
+    src="assets/PoshCodex_Demo.gif"
   />
   <div align="center">
     You just need to write a comment or variable name and the AI will write the
@@ -171,6 +171,8 @@ When you import the module for the first time, you can enter your own keybind. J
 - [x] Add a way to change the hotkey for completion by reading key input, instead of user having to call function`
 - [ ] Stream the output, instead of waiting for entire thing to be generated
   - [ ] OR Show a progress/loading indicator when inference is running
+- [ ] Switch to chat API instead of generate - to provide context of previous messages?
+- [ ] Switch from environment variables based configuration to a config file (`poshcodex.ini`)
 - [ ] Add proper documentation in `PoshCodex/Docs/about_PoshCodex.md` and `PoshCodex/Docs/Write-Completion.md`
 - [ ] Add GIF of working demo in terminal
 - [ ] Make completed text a lighter colour to show that it is only a potential solution