Skip to content

Commit 9bf73e2

Browse files
Updated documentation to fix some typo on the tutorial
1 parent c07491b commit 9bf73e2

File tree

1 file changed

+35
-23
lines changed

1 file changed

+35
-23
lines changed

index.html

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ <h2>Basic Example</h2>
6464
</p>
6565

6666
<pre><code><xmp><body ng-app="app">
67-
<oauth2
67+
<oauth
6868
site="<oauth-server-uri>"
6969
client-id="<client-id>"
7070
redirect-uri="<redirect-uri>"
71-
scope="<your-scope>"
72-
profile="<profile-uri>">
73-
</oauth2>
71+
profile-uri="<profile-uri>"
72+
scope="<scope>">
73+
</oauth>
7474

7575
<script>angular.module('app', ['ng-oauth']);</script>
7676
</body></xmp></code></pre>
@@ -185,13 +185,11 @@ <h2>Install oauth-ng</h2>
185185
<h2>AngularJS app definition</h2>
186186

187187
<p>
188-
Inject the oauth-ng module into your application and remember its initialization in your
189-
index page using the <code>ng-app</code> directive.
188+
Inject the oauth-ng module into your application.
190189
</p>
191190

192191
<pre><code><xmp>// app/scripts/app.js
193-
angular.module('newProjectApp', ['oauth'])</xmp></code></pre>
194-
192+
angular.module('newProjectApp', ['oauth', ... ])</xmp></code></pre>
195193

196194
<h2 id="server">OAuth 2.0 Server</h2>
197195

@@ -216,7 +214,7 @@ <h2>Identify your application</h2>
216214
</p>
217215

218216
<ul>
219-
<li><strong>client-id</strong> - 017b9f702a904869a6e52bd39b147bb912.</li>
217+
<li><strong>client-id</strong> - 017b9f702a904869a6e52bd39b147bb912</li>
220218
<li><strong>redirect-uri</strong> - http://localhost:9000</li>
221219
</ul>
222220

@@ -229,16 +227,16 @@ <h2>Identify your application</h2>
229227
<h2>Add the oauth-ng directive</h2>
230228

231229
<p>
232-
Open the main.html view and place the <code>oauth</code> tag with the needed configurations.
230+
Open your main.html view and place the <code>oauth</code> tag with the needed configurations.
233231
</p>
234232

235-
<pre><code><xmp>// apps/views/main.html
236-
<oauth2
233+
<pre><code><xmp><oauth
237234
site="http://oauth-ng-server.herokuapp.com"
238235
client-id="017b9f702a904869a6e52bd39b147bb912"
239236
redirect-uri="http://localhost:9000"
240-
profile="http://oauth-ng-server.herokuapp.com/profile">
241-
</oauth2></xmp></code></pre>
237+
profile-uri="http://oauth-ng-server.herokuapp.com/profile"
238+
scope="profile">
239+
</oauth></xmp></code></pre>
242240

243241
<p>
244242
Here a description for the used attributes.
@@ -251,7 +249,7 @@ <h2>Add the oauth-ng directive</h2>
251249
<span>site</span>
252250
</td>
253251
<td>
254-
The URI representing the OAuth 2.0 authorization server.
252+
OAuth 2.0 authorization server URI.
255253
</td>
256254
</tr>
257255
<tr>
@@ -267,15 +265,23 @@ <h2>Add the oauth-ng directive</h2>
267265
<span>redirect-uri</span>
268266
</td>
269267
<td>
270-
Registered application URI. Where the user is redirected after the authorization.
268+
Registered application URI. <br>Where the user is redirected after the authorization.
271269
</td>
272270
</tr>
273271
<tr>
274272
<td class="parameter">
275273
<span>profile-uri</span>
276274
</td>
277275
<td>
278-
API endpoint returning the authenticated profile resource.
276+
API endpoint to get the authenticated profile resource.
277+
</td>
278+
</tr>
279+
<tr>
280+
<td class="parameter">
281+
<span>scope</span>
282+
</td>
283+
<td>
284+
Application privileges.
279285
</td>
280286
</tr>
281287
</tbody>
@@ -593,13 +599,13 @@ <h2>1 - Template attribute</h2>
593599
Set the template path (or uri) as value for the template attribute.
594600
</p>
595601

596-
<pre><code><xmp><oauth2
602+
<pre><code><xmp><oauth
597603
template="views/templates/custom.html"
598604
client-id="<client-id>"
599605
redirect-uri="<redirect-uri>"
600-
scope="<your-scope>"
601-
profile="<profile-uri>">
602-
</oauth2></xmp></code></pre>
606+
profile-uri="<profile-uri>"
607+
scope="<your-scope>">
608+
</oauth></xmp></code></pre>
603609

604610
<h2>2 - Template event</h2>
605611

@@ -768,11 +774,17 @@ <h1 id="links">Links</h1>
768774
<h1 id="thanks">Thanks</h1>
769775

770776
<p>
771-
Project created and released as open-source thanks to <a href="http://lelylan.com" target="_blank">Lelylan</a>.<br>
772-
<a href="mailto:[email protected]" target="_blank">Mail</a> or <a href="http://twitter.com/andreareginato" target="_blank">Tweet</a>
777+
<a href="mailto:andrea.reginato@gmail.com" target="_blank">Mail</a> or
778+
<a href="http://twitter.com/andreareginato" target="_blank">Tweet</a>
773779
me for any idea that can improve the project.</p>
774780
</p>
775781

782+
<p>
783+
This project was created and released as open-source thanks to <a href="http://lelylan.com" target="_blank">Lelylan</a>,
784+
a new platform to monitor and control your devices through a simple, open and robust REST API.
785+
<br>
786+
</p>
787+
776788
</div>
777789
</section>
778790
</body>

0 commit comments

Comments
 (0)