Skip to content

Commit 63f3895

Browse files
Update README.md
1 parent 3a39782 commit 63f3895

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,10 @@
22

33
SignNow allows you to embed legally-binding e-signatures into your app, CRM or cloud storage. Send documents for signature directly from your website. Invite multiple signers to finalize contracts. Track status of your requests and download signed copies automatically.
44

5-
This is a two module application, where client-lib is a library which intended to use for the SignNow API use, taking all the routines of authentication, request building and provides simple DTO objects to use in your applications. Second module, named example-app, is a Spring Boot application which contains example implementation of use-cases of SignNow API with use of introduced client library.
5+
This is a two module application which consists of the client-lib library and the example-app module. The client-lib library is used to interact with SignNow API. It covers all the authentication routines, request building and provides simple DTO objects to use in your applications. The second module, example-app, is a Spring Boot application which contains implementation examples of SignNow API use-cases.
66

77
Get your account at https://www.signnow.com/developers
88

9-
#### API Contact Information
10-
If you have questions about the SignNow API, please visit https://docs.signnow.com or email [email protected].<br>
11-
**Support**: To contact SignNow support, please email [email protected] or [email protected].<br>
12-
**Sales**: For pricing information, please call (800) 831-2050, email [email protected] or visit https://www.signnow.com/contact.
13-
149
#### API and Application
1510
| Resources | Sandbox | Production |
1611
| --- | --- | --- |
@@ -37,7 +32,7 @@ Make sure you have Maven installed. Checkout this repo, cd into repo root direct
3732
```
3833
mvn clean install -pl client-lib
3934
```
40-
This will add client lib into your local maven repo. Next add a dependency to your app pom file:
35+
This will add client lib into your local Maven repo. Next, add a dependency to your app pom file:
4136
```xml
4237
<dependency>
4338
<groupId>com.signnow</groupId>
@@ -46,18 +41,18 @@ This will add client lib into your local maven repo. Next add a dependency to yo
4641
</dependency>
4742
```
4843

49-
In your code get SN API client instance by calling next method with corresponding parameters:
44+
In your code get SN API client instance by calling the next method with corresponding parameters:
5045
```java
5146
SNClientBuilder.get("apiUrl", "clientId", "clientSecret");
5247
```
5348

54-
If you wish to run an example application - set parameters named in the ```\example-app\src\main\resources\application.properties```
55-
Feel free to try provided examples and explore corresponding code.
49+
If you'd like to run an example application - set parameters named in the ```\example-app\src\main\resources\application.properties```
50+
Feel free to try the provided examples and explore the corresponding code.
5651

5752
## <a name="examples"></a>Examples
5853
To run the examples you will need an API key. You can get one here https://www.signnow.com/api. For a full list of accepted parameters, refer to the SignNow REST Endpoints API guide: https://docs.signnow.com/reference.
5954

60-
**Note:** next examples is a list of common use-cases only, while client library is intend to provide general wrapper and DTO objects for API calls. Thus you are not limited to mentioned here examples and free to use any provided API mapped method.
55+
**Note:** In the following examples we've listed only the common use-cases but this list shouldn't limit your requests. The client library provides an all-purpose wrapper and DTO objects for any API call to SignNow. Feel free to use any method from the client library.
6156

6257
##### User:
6358
* [Login](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Login.java#L37)
@@ -80,7 +75,7 @@ To run the examples you will need an API key. You can get one here https://www.s
8075

8176

8277
## <a name="contribution-guidelines"></a>Contribution guidelines
83-
Thanks to all contributors who got interested in this project. We're excited to hear from you. Here are some tips to make our collaboration meaningful and bring its best results to life:
78+
Many thanks to all the contributors who got interested in this project. We're excited to hear from you. Here are some tips to make our collaboration meaningful and bring its best results to life:
8479

8580
* We accept pull requests from the community. Please, send your pull requests to the **DEVELOP branch** which is the consolidated work-in-progress branch. We don't accept requests to the Master branch.
8681

@@ -94,3 +89,8 @@ Thanks to all contributors who got interested in this project. We're excited to
9489
## <a name="license"></a>License
9590

9691
This SDK is distributed under the MIT License, see [LICENSE](https://github.com/signnow/SignNowJavaAPiClient/blob/master/LICENSE) for more information.
92+
93+
#### API Contact Information
94+
If you have questions about the SignNow API, please visit https://docs.signnow.com or email [email protected].<br>
95+
**Support**: To contact SignNow support, please email [email protected] or [email protected].<br>
96+
**Sales**: For pricing information, please call (800) 831-2050, email [email protected] or visit https://www.signnow.com/contact.

0 commit comments

Comments
 (0)