You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,24 +8,24 @@ The Mac API Tool is a lightweight menu bar application designed to improve the w
8
8
This application has been intended for use on Mac’s running OS 11.0 and higher. It was built in Xcode 12.2.
9
9
10
10
## Installation Instructions
11
-
1. Instructions here
11
+
1. Instructions coming soon (working on getting Developer ID)
12
12
13
13
## Uninstalling The Application (VERY IMPORTANT)
14
14
If the application is running, you may experience an error when uninstalling but this is easily fixed with the following steps.
15
15
1. Open the application using its menu bar icon.
16
16
2. Press the “Quit App” button to terminate all processes relate to the application.
17
17
3. Now, you should be able to remove the application from your Applications folder for uninstalling. The icon will no longer show up on the menu bar.
18
-
4. If all else fails, you are also able to kill any relate processes from the “Activity Monitor.”
18
+
4. If all else fails, you are also able to kill any related processes from the “Activity Monitor.”
19
19
20
20
## Features
21
21
1. QUIT APP BUTTON: This is a very important feature. Users can click this button to quit the app process and remove it from the toolbar. However, the only true use case is when uninstalling the app. Users must press this first to stop the app process, so that it may be moved from the Applications folder to Trash.
22
22
2. Users enter their target url at the top of the application. Error handling warns when no url has been entered.
23
23
3. Users can make GET, POST, PUT, and DELETE requests through the tool. These are the 4 main operations for REST APIs.
24
24
4. The interface provides a text area for easily entering query parameters. Each line includes a key value pair separated by an equals sign. This interface may be upgraded in a future release.
25
25
5. The text area for query parameters serves as the request body for POST, PUT, and DELETE requests.
26
-
6. There is a separate place to enter the auth parameter and value for an API call. This would be a great place to enter the API key or an access token.
26
+
6. There is a separate place to enter the auth parameter and value for an API call. This would be a great place to enter an API key or an access token.
27
27
7. There is a button to send a request and a button to clear the values in all fields at once.
28
-
8. The response area pretty prints the request’s response data and can be easily copy and pasted. The status code is also displayed. The code will be red if it represents an error occurring.
28
+
8. The response area pretty prints the request’s response data and can be easily copy and pasted. The status code is also displayed. The code will be red if an error occurred.
29
29
9. The divider between the request info and response areas can be moved to expand either area for better viewing.
0 commit comments