Merge pull request #84 from sashirestela/83-update-readme

Update Readme and Contributing
sashirestela · Apr 8, 2024 · 0170212 · 0170212
2 parents bf4f5c6 + 3ef8046
commit 0170212
Show file tree

Hide file tree

Showing 23 changed files with 45 additions and 43 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,13 +1,12 @@
 # Contributing
-Thank you very much for your interest in contributing to the improvement of **Simple-OpenAI**. Please, follow the next guidelines.
+Thank you very much for your interest in contributing to the improvement of this project. Please, follow the next guidelines.
 
 ## General Guidelines
 1. Keep the code compatible with Java 11.
 1. Follow existing code styles present in the project.
 1. Avoid adding new dependencies as much as possible.
 1. Ensure to add Javadoc where necessary.
 1. Provide unit tests for your code.
-1. Provide demo code to use real services. Use environment variables for credentials.
 1. Large features should be discussed with maintainers before implementation. Use the [Discussion](https://github.com/sashirestela/simple-openai/discussions) section for this.
 
 ## Code Formatting
@@ -30,45 +29,48 @@ You could set your favorite IDE to be aligned to the custom code format. See det
 
 1. Import the custom code format:
 
-<img src="media/intellij/set_format_intellij_1.png" width="788">
+    - Settings > Editor > Code Style > Java > Scheme > ⚙ > Import Scheme > Eclipse XML Profile
 
-2. Select the file on _codestyle/spotless_java_eclipseformat.xml_:
+2. Select the file on _codestyle/spotless_java_eclipseformat.xml_
 
-<img src="media/intellij/set_format_intellij_2.png" width="372">
+3. In the _Imports_ tab for the previous scheme, change the values:
+    - In _General_ section, mark the option _Use single class import_
+    - In the field _Class count to use import with '*'_ put the value 99
+    - In the field _Names count to use static import with '*'_ put the value 99
 
-<img src="media/intellij/set_format_intellij_3.png" width="214">
-
-3. In the _Imports_ section, change the values as in the image:
-
-<img src="media/intellij/set_imports_intellij_1.png" width="788">
-
-4. At the bottom part in the _Imports_ section, change the _import statement order_ as in the image:
-
-<img src="media/intellij/set_imports_intellij_2.png" width="583">
-
-<img src="media/intellij/set_imports_intellij_3.png" width="583">
+4. At the bottom part in the _Imports_ section, change the import statement order as:
+    - **import** all other imports
+    - **import** javax.*
+    - **import** java.*
+    - **import static** all other imports
 
 </details>
 
 <details>
 
 <summary><b>VSCode</b></summary>
 
-1. Install the extension _Language Support for Java by Red Hat_:
-
-<img src="media/vscode/install_extension_vscode.png" width="511">
+1. Install the extension _Language Support for Java by Red Hat_
 
-2. Set the custom code format using the value _codestyle/spotless_java_eclipseformat.xml_:
+2. Set the custom code format:
+
+    - Settings > Workspace > Extensions > Language Support for Java(TM) by Red Hat > Formatting
+    - Choose the box _Java/Format/Settings:Url_ and put the value _codestyle/spotless_java_eclipseformat.xml_
 
-<img src="media/vscode/set_format_vscode.png" width="673">
+3. Set the import order:
 
-3. Configure the _Import Order_ by clicking in the link:
+    - Settings > Workspace > Extensions > Language Support for Java(TM) by Red Hat > Code Completion
+    - Choose the box _Java/Completion:ImportOrder_ and click the link _Edit in settings.json_
+    - In the editor, make sure to add the following entries:
 
-<img src="media/vscode/set_imports_vscode_1.png" width="673">
-
-4. Set the _import statement order_ as in the image:
-
-<img src="media/vscode/set_imports_vscode_2.png" width="513">
+      ```json
+      "java.completion.importOrder": [
+          "",
+          "javax",
+          "java",
+          "*"
+      ]
+      ```
 
 </details>
 
@@ -78,24 +80,24 @@ You could set your favorite IDE to be aligned to the custom code format. See det
 
 1. Import the custom code format:
 
-<img src="media/eclipse/set_format_eclipse_1.png" width="668">
-
-2. Select the file on _codestyle/spotless_java_eclipseformat.xml_:
+    - Preferences > Java > Code Style > Formatter > Import...
 
-<img src="media/eclipse/set_format_eclipse_2.png" width="584">
-
-<img src="media/eclipse/set_format_eclipse_3.png" width="668">
+2. Select the file on _codestyle/spotless_java_eclipseformat.xml_
 
 3. Import the custom import statement order:
 
-<img src="media/eclipse/set_imports_eclipse_1.png" width="668">
-
-4. Select the file on _codestyle/spotless_java.importorder_:
+    - Preferences > Java > Code Style > Organize Imports > Import...
 
-<img src="media/eclipse/set_imports_eclipse_2.png" width="584">
+4. Select the file on _codestyle/spotless_java.importorder_
 
-5. In the _Organize Imports_ section, make sure you see the values as in the image:
+5. In the _Organize Imports_ section, make sure the values are set as:
 
-<img src="media/eclipse/set_imports_eclipse_3.png" width="510">
+    - Sorting order:
+      - \* - all unmatched type imports
+      - javax
+      - java
+      - \* - all unmatched static imports
+    - Number of imports needed for .*: 99
+    - Number of static imports needed for .*: 99
 
-</details>
+</details>
diff --git a/README.md b/README.md
@@ -74,9 +74,9 @@ Full support for all of the OpenAI services:
 * Assistants API (Beta)
 * Assistant Stream Events (Beta) 📣
 
-![Services](media/supported_services.png)
+![OpenAI Services](media/openai_services.png)
 
-![Assitants API](media/assistants_api.png)
+![OpenAI Beta Services](media/openai_beta_services.png)
 
 NOTE: All the responses are ```CompletableFuture<ResponseObject>```, which means they are asynchronous, but you can call the join() method to return the result value when complete.
 

diff --git a/media/assistants_api.png b/media/assistants_api.png
diff --git a/media/eclipse/set_format_eclipse_1.png b/media/eclipse/set_format_eclipse_1.png
diff --git a/media/eclipse/set_format_eclipse_2.png b/media/eclipse/set_format_eclipse_2.png
diff --git a/media/eclipse/set_format_eclipse_3.png b/media/eclipse/set_format_eclipse_3.png
diff --git a/media/eclipse/set_imports_eclipse_1.png b/media/eclipse/set_imports_eclipse_1.png
diff --git a/media/eclipse/set_imports_eclipse_2.png b/media/eclipse/set_imports_eclipse_2.png
diff --git a/media/eclipse/set_imports_eclipse_3.png b/media/eclipse/set_imports_eclipse_3.png
diff --git a/media/intellij/set_format_intellij_1.png b/media/intellij/set_format_intellij_1.png
diff --git a/media/intellij/set_format_intellij_2.png b/media/intellij/set_format_intellij_2.png
diff --git a/media/intellij/set_format_intellij_3.png b/media/intellij/set_format_intellij_3.png
diff --git a/media/intellij/set_imports_intellij_1.png b/media/intellij/set_imports_intellij_1.png
diff --git a/media/intellij/set_imports_intellij_2.png b/media/intellij/set_imports_intellij_2.png
diff --git a/media/intellij/set_imports_intellij_3.png b/media/intellij/set_imports_intellij_3.png
diff --git a/media/openai_beta_services.png b/media/openai_beta_services.png
diff --git a/media/openai_services.png b/media/openai_services.png
diff --git a/media/supported_services.png b/media/supported_services.png
diff --git a/media/vscode/install_extension_vscode.png b/media/vscode/install_extension_vscode.png
diff --git a/media/vscode/set_format_vscode.png b/media/vscode/set_format_vscode.png
diff --git a/media/vscode/set_imports_vscode_1.png b/media/vscode/set_imports_vscode_1.png
diff --git a/media/vscode/set_imports_vscode_2.png b/media/vscode/set_imports_vscode_2.png
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
   <groupId>io.github.sashirestela</groupId>
   <artifactId>simple-openai</artifactId>
-  <version>2.1.1</version>
+  <version>2.2.0</version>
   <packaging>jar</packaging>
 
   <name>simple-openai</name>