Skip to content

Commit 61760e6

Browse files
authored
Fix/proofread README.md
1 parent 411d937 commit 61760e6

File tree

1 file changed

+20
-26
lines changed

1 file changed

+20
-26
lines changed

README.md

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ Aspose.OCR Cloud SDK for Go is open source under the MIT license. You can freely
1717

1818
## System requirements
1919

20+
- Go 1.18 or later.
2021
- Internet connection.
2122
- Access to the **api.aspose.cloud** domain.
22-
- Go version 1.18
23-
- The actual dependencies are listed in go.mod file
23+
24+
Check [go.mod](go.mod) file for the full list of third-party dependencies.
2425

2526
## Get started
2627

@@ -54,39 +55,37 @@ Aspose.OCR Cloud follows industry standards and best practices to keep your data
5455

5556
### Running demo
5657

57-
1. Clone our repository
58-
2. Install package
58+
1. Clone this repository or [download](https://github.com/aspose-ocr-cloud/aspose-ocr-cloud-go/archive/refs/heads/master.zip) it as ZIP.
59+
3. Install **Aspose.OCR Cloud SDK for Go** package:
5960
```shell
6061
go get github.com/aspose-ocr-cloud/aspose-ocr-cloud-go
6162
```
62-
3. Open [examples\example.go](examples\example.go) file and replace "YOUR_CLIENT_ID" and "YOUR_CLIENT_SECRET" with your credentials
63+
3. Open [examples/example.go](examples/example.go) file and replace "YOUR_CLIENT_ID" and "YOUR_CLIENT_SECRET" with credentials obtained during **Authorization** phase:
6364
```go
65+
func main() {
6466

65-
func main(){
66-
6767
clientId := "YOUR_CLIENT_ID"
6868
clientSecret := "YOUR_CLIENT_SECRET"
69-
...
70-
```
71-
4. Open a new terminal and navigate to the aspose-ocr-cloud-go/example/ directory
72-
```shell
73-
cd <path_to_sdk>/aspose-ocr-cloud-go/example/
7469
```
75-
5. Run example
70+
4. Open the terminal and navigate to the _example_ directory of the downloaded repository.
71+
5. Run the example:
7672
```shell
7773
go run .\example.go
7874
```
79-
6. Files with test results will appear in the aspose-ocr-cloud-go/results/ folder
75+
6. Recognition results will be saved to the `results` directory of the downloaded repository.
8076
81-
Also, as a demo application, you can use the tests
82-
1. Clone our repository
83-
2. Install dependencies
77+
### Running tests
78+
79+
We also provide automated tests for [Testify](https://github.com/stretchr/testify).
80+
81+
1. Clone this repository or [download](https://github.com/aspose-ocr-cloud/aspose-ocr-cloud-go/archive/refs/heads/master.zip) it as ZIP.
82+
2. Install dependencies:
8483
```shell
8584
go get github.com/stretchr/testify/assert
8685
go get github.com/stretchr/testify/require
8786
go get golang.org/x/oauth2
8887
```
89-
3. In the file [test/test_config.go](test/test_config.go) enter **Client ID** and **Client Secret**
88+
3. Open [test/test_config.go](test/test_config.go) file and replace "YOUR_CLIENT_ID" and "YOUR_CLIENT_SECRET" with credentials obtained during **Authorization** phase:
9089
```go
9190
package asposeocrcloud
9291

@@ -95,17 +94,12 @@ var (
9594
ConfigClientSecret = "YOUR_CLIENT_SECRET"
9695
)
9796
```
98-
4. Open a new terminal and navigate to the aspose-ocr-cloud-go/test/ directory
99-
```shell
100-
cd <path_to_sdk>/aspose-ocr-cloud-go/test/
101-
```
102-
5. Run the tests with the command
97+
4. Open the terminal and navigate to the _test_ directory of the downloaded repository.
98+
5. Run tests:
10399
```
104100
go test github.com/aspose-ocr-cloud/aspose-ocr-cloud-go/test
105101
```
106-
6. Files with test results will appear in the aspose-ocr-cloud-go/results/ folder
107-
108-
[Download demo as ZIP archive](https://github.com/aspose-ocr-cloud/aspose-ocr-cloud-go/archive/refs/heads/master.zip)
102+
6. Test results will be saved to the `results` directory of the downloaded repository.
109103
110104
## What was changed in version 23.7.0
111105

0 commit comments

Comments
 (0)