Skip to content

Commit b215f50

Browse files
author
Giovanni D'Andrea
committed
fix: updated readme documentation and asset files
1 parent a80d18a commit b215f50

File tree

4 files changed

+16
-7
lines changed

4 files changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
<div align="center">
2-
<img src="./assets/logo.png" alt="codeishot logo" width="100">
2+
<img src="./assets/logo.png" alt="codeishot logo" width="400" style="border-radius: 8px;">
33
<br>
44
</div>
55

66
# Codeishot VSCode Extension
77

8-
## Overview
9-
108
Codeishot is a Visual Studio Code extension designed to enhance the coding experience by allowing users to quickly share code snippets directly from the editor. It captures selected text, posts it to a local server, and provides a shareable URL to the user.
119

1210
## Features
@@ -15,6 +13,7 @@ Codeishot is a Visual Studio Code extension designed to enhance the coding exper
1513
- **Clipboard Integration**: Automatically copies the snippet URL to the clipboard.
1614
- **Error Handling**: Comprehensive error messages for a smooth user experience.
1715
- **Language Support**: Language detection.
16+
- **Codeishot Authentication**: Added login function to authenticate personal snippets.
1817

1918
## Installation
2019

@@ -28,12 +27,22 @@ To use Codeishot:
2827

2928
1. Open a file in VSCode.
3029
2. Select the code snippet you want to share.
31-
3. Execute the `Codeishot: Share snippet` command (or use `Shift + c` shortcut).
32-
4. The URL of the posted snippet is automatically copied to your clipboard.
33-
5. Optionally, click on the pop-up message to open the snippet URL in a browser.
30+
3. Open the vscode command palette `Shift + P`
31+
4. Execute the `Share on Codeishot ✨` command (or use `Option + Shift + c` shortcut).
32+
5. The URL of the posted snippet is automatically copied to your clipboard.
33+
6. Optionally, click on the pop-up message to open the snippet URL in a browser.
3434

3535
![palette](./assets/cmd_palette.png)
3636

37+
To login into Codeishot:
38+
39+
1. Open the command palette.
40+
2. Open the vscode command palette `Shift + P`
41+
3. Click on `Login to Codeishot ✨`.
42+
4. Follow the Flow.
43+
44+
![login](./assets/cmd_palette.png)
45+
3746
## Configuration
3847

3948
- **Base URL**: Set to `https://codeishot.com` by default. Change it in the code if you're using a different server.
@@ -67,4 +76,4 @@ For support or queries, reach out to one of the maintainers.
6776

6877
---
6978

70-
Codeishot © [2023] by [Codeishot]
79+
Codeishot © [2024] by [Codeishot]

assets/cmd_login.png

22.8 KB
Loading

assets/cmd_palette.png

17.1 KB
Loading

assets/logo.png

105 KB
Loading

0 commit comments

Comments
 (0)