Skip to content

Commit c46df6f

Browse files
committed
Improve UI/UX and add customization options/features
1 parent d2d1481 commit c46df6f

File tree

1 file changed

+74
-26
lines changed

1 file changed

+74
-26
lines changed

README.md

Lines changed: 74 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -48,42 +48,90 @@ You can change these settings on the options page.
4848

4949
## TODO
5050

51-
- [x] Add support for internationalization (i18n)
52-
- [x] Add support for generating abstracts from selected text on the page
53-
- [x] Add support for generating keywords from the content
54-
- [x] Add support for generating APA citations for the page
55-
- [x] Add support for copying the generated abstract, keywords, and citation in different formats
56-
- [x] Write a suitable CONTRIBUTING.md file for the project :wink:
57-
- [x] Add a tab for About and Credits
58-
- [ ] Recover and save last abstract and keywords generated for a given page
59-
- [ ] Add support to export lists of abstracts and keywords to clipboard
60-
- [ ] Add support to write the abstract and keywords to a new tab
61-
- [ ] Add support for generating abstracts from multiple tabs at once
62-
- [ ] Add support for more API models and parameters
63-
- [ ] Add more languages to the supported locales
64-
- [ ] Improve error handling and user feedback
65-
- [ ] Add more customization options and features
66-
- [ ] Improve the UI/UX of the extension popup and options page
67-
51+
- [x] :white_check_mark: Add support for internationalization (i18n)
52+
- [x] :white_check_mark: Add support for generating abstracts from selected text on the page
53+
- [x] :white_check_mark: Add support for generating keywords from the content
54+
- [x] :white_check_mark: Add support for generating APA citations for the page
55+
- [x] :white_check_mark: Add support for copying the generated abstract, keywords, and citation in different formats
56+
- [x] :white_check_mark: Write a suitable CONTRIBUTING.md file for the project :wink:
57+
- [x] :white_check_mark: Add a tab for About and Credits
58+
- [ ] :construction: Improve the UI/UX of the extension popup and options page
59+
- [ ] :construction: Add more customization options and features
60+
- [ ] :soon: Recover and save last abstract and keywords generated for a given page
61+
- [ ] :soon: Add support to export lists of abstracts and keywords to clipboard
62+
- [ ] :soon: Add support to write the abstract and keywords to a new tab
63+
- [ ] :soon: Add support for generating abstracts from multiple tabs at once
64+
- [ ] :soon: Add support for more API models and parameters
65+
- [ ] :soon: Add more languages to the supported locales
66+
- [ ] :soon: Improve error handling and user feedback
67+
68+
## Main structure
69+
```bash
70+
quick-abstract/
71+
72+
├── icons/
73+
│ ├── icon-16.png
74+
│ ├── icon-32.png
75+
│ ├── icon-48.png
76+
│ ├── icon-64.png
77+
│ ├── icon-96.png
78+
│ ├── icon-128.png
79+
│ └── icon.png
80+
81+
├── _locales/
82+
│ ├── en/
83+
│ │ └── messages.json
84+
│ ├── es/
85+
│ │ └── messages.json
86+
│ └── fr/
87+
│ └── messages.json
88+
89+
├── lib/
90+
│ └── purify.min.js
91+
92+
├── background/
93+
│ └── background.js
94+
95+
├── options/
96+
│ ├── options.html
97+
│ ├── options.js
98+
│ └── options.css
99+
100+
├── popup/
101+
│ ├── extension.html
102+
│ ├── extension.js
103+
│ └── popup.js
104+
105+
├── style/
106+
│ └── style.css
107+
108+
├── CONTRIBUTING.md
109+
├── LICENSE
110+
├── manifest.json
111+
└── README.md
112+
```
68113

69114

70115
## Files
71116

72117
- `manifest.json`: The extension manifest file defining metadata, permissions, and scripts
73-
- `extension.html`: The HTML structure for the extension popup
74-
- `extension.js`: JavaScript for handling tabs interactions
75-
- `popup.js`: JavaScript handling popup interactions and API calls
76-
- `background.js`: Background script for handling API requests and responses
77-
- `options.html`: Options page for configuring API key, model, and temperature
78-
- `options.js`: JavaScript for handling options page interactions and storage
79-
- `style.css`: Stylesheet for the extension
80-
- `icons/`: Directory containing the extension icons in various sizes
81-
- `_locales/`: Directory containing language-specific message files
82118
- `LICENSE`: License file for the project
83119
- `README.md`: Readme file with information about the extension
120+
- `CONTRIBUTING.md`: Contributing guidelines for the project
121+
- `popup/extension.html`: The HTML structure for the extension popup
122+
- `popup/extension.js`: JavaScript for handling tabs interactions
123+
- `popup/popup.js`: JavaScript handling popup interactions and API calls
124+
- `background/background.js`: Background script for handling API requests and responses
125+
- `options/options.html`: Options page for configuring API key, model, and temperature
126+
- `options/options.js`: JavaScript for handling options page interactions and storage
127+
- `options/options.css`: Stylesheet for the options page
128+
- `style/style.css`: Stylesheet for the extension
129+
- `icons/`: Directory containing the extension icons in various sizes
130+
- `_locales/`: Directory containing language-specific message files
84131
- `lib/`: Directory containing third-party libraries used in the extension (DOMPurify by now)
85132

86133

134+
87135
## Dependencies
88136

89137
This extension relies on the Perplexity AI API. You need to sign up for an API key at [https://www.perplexity.ai/](https://www.perplexity.ai/) to use this extension.

0 commit comments

Comments
 (0)