Skip to content

Commit 795ca9b

Browse files
authored
docs: Moved usage and enviorment variables to USAGE.md (#86)
* Moved the example and example link along with the environment variables to the USAGE.md * Changed the Table of Contents to reference the new USAGE.md
1 parent 805d0b6 commit 795ca9b

File tree

2 files changed

+10
-33
lines changed

2 files changed

+10
-33
lines changed

README.md

+1-32
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you are looking for the SendGrid API client library, please see [this repo](h
1515
* [Announcements](#announcements)
1616
* [Installation](#installation)
1717
* [Quick Start](#quick-start)
18-
* [Usage](#usage)
18+
* [Usage](./USAGE.md)
1919
* [Roadmap](#roadmap)
2020
* [How to Contribute](#contribute)
2121
* [About](#about)
@@ -116,37 +116,6 @@ try {
116116
}
117117
```
118118

119-
<a name="usage"></a>
120-
# Usage
121-
122-
- [Example Code](https://github.com/sendgrid/java-http-client/tree/master/examples)
123-
- [Library Usage Documentation](USAGE.md)
124-
125-
126-
The example uses SendGrid, you can get your free account [here](https://sendgrid.com/free?source=java-http-client).
127-
128-
First, update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys).
129-
130-
```bash
131-
echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
132-
echo "sendgrid.env" >> .gitignore
133-
source ./sendgrid.env
134-
```
135-
136-
```bash
137-
mvn package
138-
cd examples
139-
javac -classpath {path_to}/sendgrid-java-http-client-4.0.0-jar.jar:. Example.java && java -classpath {path_to}/sendgrid-java-http-client-4.0.0-jar.jar:. Example
140-
```
141-
142-
## Environment Variables
143-
144-
You can do the following to create a .env file:
145-
146-
```cp .env_example .env```
147-
148-
Then, just add your API Key into your .env file.
149-
150119
<a name="roadmap"></a>
151120
# Roadmap
152121

USAGE.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,12 @@ source ./sendgrid.env
1616
mvn package
1717
cd examples
1818
javac -classpath {path_to}/sendgrid-java-http-client-4.0.0-jar.jar:. Example.java && java -classpath {path_to}/sendgrid-java-http-client-4.0.0-jar.jar:. Example
19-
```
19+
```
20+
21+
## Environment Variables
22+
23+
You can do the following to create a .env file:
24+
25+
```cp .env_example .env```
26+
27+
Then, just add your API Key into your .env file.

0 commit comments

Comments
 (0)