Permalink
Browse files

Tidied up README.

  • Loading branch information...
1 parent 9cfd4ee commit 9208512a5a09a1ea082b435e7711a4476b57e447 @aaronrussell committed May 25, 2010
Showing with 15 additions and 14 deletions.
  1. +1 −1 LICENSE
  2. +12 −13 README.rdoc
  3. +2 −0 lib/freeagent_api.rb
View
2 LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2010 Aaron Russell & Alex Coomans
+Copyright (c) 2009-2010 Aaron Russell
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
25 README.rdoc
@@ -233,27 +233,26 @@ Please note: version 0.2 is significantly different from 0.1 so if you are upgra
<b>Find users</b>
- @users = User.find :all # returns all users
+ @users = User.find :all # returns all users
@user = User.find id # returns specific user
- @user = User.find_by_email email
+ @user = User.find_by_email email
<b>Create user</b>
# Required attributes
- # :first_name
- # :last_name
- # :email
- # :role # must be Owner, Director, Partner, Company Secretary, Employee, Shareholder, or Accountant
- # :password
- # :password_confirmation
-
-
+ # :first_name
+ # :last_name
+ # :email
+ # :role # must be Owner, Director, Partner, Company Secretary, Employee, Shareholder, or Accountant
+ # :password
+ # :password_confirmation
+
@user = User.new params
@user.save
<b>Update user</b>
- @user.first_name = '3.5'
+ @user.first_name = 'Joe Bloggs'
@user.save
<b>Delete user</b>
@@ -262,11 +261,11 @@ Please note: version 0.2 is significantly different from 0.1 so if you are upgra
# or
@user.destroy
-== Author
+== Author & Contributors
* Aaron Russell - (www.aaronrussell.co.uk)
* Alex Comans - (www.alexcoomans.com)
== Copyright
-Copyright (c) 2010 Aaron Russell & Alex Coomans. See LICENSE for details.
+Copyright (c) 2009-2010 Aaron Russell. See LICENSE for details.
View
2 lib/freeagent_api.rb
@@ -113,6 +113,7 @@ def self.find(*arguments)
end
# Users
+
class User < Base
self.prefix = '/company/'
def self.find_by_email(email)
@@ -123,4 +124,5 @@ def self.find_by_email(email)
raise Error, "No user matches that email!"
end
end
+
end

0 comments on commit 9208512

Please sign in to comment.