Skip to content

Commit 0ca98a0

Browse files
committed
fix README
1 parent 05a1081 commit 0ca98a0

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Logo](./Assets/piiLogo.png)
1+
![Logo](./Assets/projectLogo.png)
22

33
Source code for the documentation-generator-pii extension on VSCode.
44

@@ -39,22 +39,31 @@ Insert gif or link to demo
3939

4040
Search for it in the extension marketplace or click here. *link here*
4141

42+
### Smart Comments Integration
43+
Open the settings view, search for the extension and paste your own API token. You might need to relaunch the extension afterwards.
44+
4245
<br>
4346

4447
## 🐛 Known Issues
4548

46-
kifik
49+
- Formatting bug on some functions
50+
- Parser bugs if the language comment symbol is used in a code snippet
51+
- Comment ID generation might lag
4752

4853
<br>
4954

5055
## 🙅‍♂️ Limitations
5156

52-
ecrire wen c pas bien
57+
- Code becomes unreadable if a toddlers uses the extension
58+
- Syntax of custom comments hard not admirable
59+
- We need custom comments
5360

5461
<br>
5562

5663
## 📝 TODO
5764
- Support HTML and PDF
65+
- More designs
66+
- Bug fixes
5867

5968
<br>
6069

0 commit comments

Comments
 (0)