Skip to content

Commit 627e1e0

Browse files
committed
Update README
1 parent e689769 commit 627e1e0

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,22 @@ Sentiments is an iOS app written in Swift that analyzes text for positive or neg
77

88
## Usage
99

10+
### Sentiments
11+
1012
1. Open `Sentiment-Analysis.xcworkspace`.
1113
2. Replace "YOUR_API_KEY" with your API key from [HPE Haven OnDemand](https://www.havenondemand.com) in [`AppConfig.swift`](https://github.com/kyleweiner/Sentiments/tree/master/Sentiment-Analysis/Constants/AppConfig.swift).
1214
3. Enter text in the text field and press the check button.
1315

16+
### Highlight Sentiment Extension
17+
18+
The project includes an experimental action extension for analyzing the sentiment of text on a web page. The extension behaves similarly to the containing app–positive sentiment is highlighted in green and negative sentiment is highlighted in red.
19+
20+
1. Launch Safari and navigate to a web page.
21+
2. Tap the share button.
22+
3. Tap the "Highlight Sentiment" icon.
23+
24+
Note that the extension must first be enabled to complete step 3.
25+
1426
## Author
1527

1628
Sentiments was written and designed by Kyle Weiner. It uses [Alamofire](https://github.com/Alamofire/Alamofire), [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON) and [HPE Haven OnDemand](https://dev.havenondemand.com/apis/analyzesentiment#overview)'s Sentiment Analysis API.

0 commit comments

Comments
 (0)