Skip to content

Commit 340e2bc

Browse files
author
Paul Gray
committed
Adding slightly better docs to README.md
1 parent 60daeff commit 340e2bc

File tree

1 file changed

+51
-12
lines changed

1 file changed

+51
-12
lines changed

README.md

Lines changed: 51 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,48 @@ Include in your project's `pom.xml`:
2323
<version>1.1.1</version>
2424
</dependency>
2525
```
26-
Examples:
27-
---------
2826

29-
LTI Producer:
27+
This library provides support for:
28+
29+
**Tool Providers**:
30+
31+
1. Verifying an LTI launch request
32+
2. Sending LTI 1.1 Outcomes request (xml-based)
33+
3. AspectJ launch verifiers for easy integration with Spring-web.
34+
35+
**Tool Consumers**s:
36+
37+
1. Creating a valid LTI launch request
38+
39+
Some exploratory support for LTIv2:
40+
41+
1. Parsing Tool Profiles
42+
2. Validating Tool Capabilities & Services
43+
44+
45+
LTI Providers:
46+
----
47+
48+
**Verifying an LTI launch request.**
49+
50+
```java
51+
HttpServletRequest request; // java servlet request
52+
LtiVerifier ltiVerifier = new LtiOauthVerifier();
53+
LtiVerificationResult ltiResult = ltiVerifier.verify(
54+
request, request.getParameter("oauth_consumer_key"));
55+
```
56+
57+
**Sending LTI 1.1 Outcomes request (xml-based).**
58+
59+
```java
60+
//send Request directly
61+
IMSPOXRequest.sendReplaceResult(url, key, secret, sourcedid, score);
62+
63+
//or build the request to send later:
64+
HttpPost request = IMSPOXRequest.buildReplaceResult(url, key, secret, sourcedid, score, true);
65+
```
66+
67+
**AspectJ launch verifiers for easy integration with Spring-web.**
3068

3169
Spring Controller (LTI Producer):
3270
```java
@@ -40,6 +78,7 @@ public String ltiEntry(HttpServletRequest request, LtiVerificationResult result)
4078
}
4179
}
4280
```
81+
4382
KeyService Implementation:
4483
```java
4584
public class MockKeyService implements LtiKeySecretService {
@@ -59,16 +98,16 @@ Spring Context xml:
5998
</constructor-arg>
6099
</bean>
61100
```
62-
How to Contribute:
63-
------------------
64-
1. Fork the repo
65-
2. Add changes
66-
3. Send a pull request with those changes
67101

68-
TODO List:
69-
--------------
102+
LTI Consumers:
103+
----
104+
105+
**Building an LTI launch request.**
106+
107+
```java
108+
LtiSigner ltiSigner = new LtiOauthSigner();
109+
Map<String, String> signedParameters = signParameters(parameters, key, secret, url, "POST");
110+
```
70111

71-
- [ ] Write Unit tests for LTI Consumer code
72-
- [ ] Write Unit tests for LTI 2 code
73112

74113
© 2014 IMS Global Learning Consortium, Inc. All Rights Reserved.

0 commit comments

Comments
 (0)