Skip to content

Commit 9fbe188

Browse files
authored
Turn examples/README into markdown [ci skip]
1 parent 941a829 commit 9fbe188

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

examples/README examples/README.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,35 @@ OpenID library. Make sure you have properly installed the library
33
before running the examples. These examples are a great place to
44
start in integrating OpenID into your application.
55

6-
==Rails example
6+
## Rails example
77

8-
The rails_openid contains a fully functional OpenID server and relying
8+
The `rails_openid` directory contains a fully functional OpenID server and relying
99
party, and acts as a starting point for implementing your own
1010
production rails server. You'll need the latest version of Ruby on
1111
Rails installed, and then:
1212

13-
cd rails_openid
14-
./script/server
13+
```shell
14+
cd rails_openid
15+
./script/server
16+
```
1517

1618
Open a web browser to http://localhost:3000/ and follow the instructions.
1719

1820
The relevant code to work from when writing your Rails OpenID Relying
1921
Party is:
22+
2023
rails_openid/app/controllers/consumer_controller.rb
24+
2125
If you are working on an OpenID provider, check out
26+
2227
rails_openid/app/controllers/server_controller.rb
2328

2429
Since the library and examples are Apache-licensed, don't be shy about
2530
copy-and-paste.
2631

27-
==Rails ActiveRecord OpenIDStore plugin
32+
## Rails ActiveRecord OpenIDStore plugin
2833

2934
For various reasons you may want or need to deploy your ruby openid
30-
consumer/server using an SQL based store. The active_record_openid_store
35+
consumer/server using an SQL based store. The `active_record_openid_store`
3136
is a plugin that makes using an SQL based store simple. Follow the
3237
README inside the plugin's dir for usage.

0 commit comments

Comments
 (0)