Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Tidied up README.

  • Loading branch information...
commit 9208512a5a09a1ea082b435e7711a4476b57e447 1 parent 9cfd4ee
Aaron Russell authored

Showing 3 changed files with 15 additions and 14 deletions. Show diff stats Hide diff stats

  1. +1 1  LICENSE
  2. +12 13 README.rdoc
  3. +2 0  lib/freeagent_api.rb
2  LICENSE
... ... @@ -1,4 +1,4 @@
1   -Copyright (c) 2010 Aaron Russell & Alex Coomans
  1 +Copyright (c) 2009-2010 Aaron Russell
2 2
3 3 Permission is hereby granted, free of charge, to any person obtaining
4 4 a copy of this software and associated documentation files (the
25 README.rdoc
Source Rendered
@@ -233,27 +233,26 @@ Please note: version 0.2 is significantly different from 0.1 so if you are upgra
233 233
234 234 <b>Find users</b>
235 235
236   - @users = User.find :all # returns all users
  236 + @users = User.find :all # returns all users
237 237 @user = User.find id # returns specific user
238   - @user = User.find_by_email email
  238 + @user = User.find_by_email email
239 239
240 240 <b>Create user</b>
241 241
242 242 # Required attributes
243   - # :first_name
244   - # :last_name
245   - # :email
246   - # :role # must be Owner, Director, Partner, Company Secretary, Employee, Shareholder, or Accountant
247   - # :password
248   - # :password_confirmation
249   -
250   -
  243 + # :first_name
  244 + # :last_name
  245 + # :email
  246 + # :role # must be Owner, Director, Partner, Company Secretary, Employee, Shareholder, or Accountant
  247 + # :password
  248 + # :password_confirmation
  249 +
251 250 @user = User.new params
252 251 @user.save
253 252
254 253 <b>Update user</b>
255 254
256   - @user.first_name = '3.5'
  255 + @user.first_name = 'Joe Bloggs'
257 256 @user.save
258 257
259 258 <b>Delete user</b>
@@ -262,11 +261,11 @@ Please note: version 0.2 is significantly different from 0.1 so if you are upgra
262 261 # or
263 262 @user.destroy
264 263
265   -== Author
  264 +== Author & Contributors
266 265
267 266 * Aaron Russell - (www.aaronrussell.co.uk)
268 267 * Alex Comans - (www.alexcoomans.com)
269 268
270 269 == Copyright
271 270
272   -Copyright (c) 2010 Aaron Russell & Alex Coomans. See LICENSE for details.
  271 +Copyright (c) 2009-2010 Aaron Russell. See LICENSE for details.
2  lib/freeagent_api.rb
@@ -113,6 +113,7 @@ def self.find(*arguments)
113 113 end
114 114
115 115 # Users
  116 +
116 117 class User < Base
117 118 self.prefix = '/company/'
118 119 def self.find_by_email(email)
@@ -123,4 +124,5 @@ def self.find_by_email(email)
123 124 raise Error, "No user matches that email!"
124 125 end
125 126 end
  127 +
126 128 end

0 comments on commit 9208512

Please sign in to comment.
Something went wrong with that request. Please try again.