Skip to content

Commit 973f32e

Browse files
author
Olly Headey
committed
Update README for clarity on library status
1 parent a2555bc commit 973f32e

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
Description
22
-----------
3-
The official [FreeAgent](http://www.freeagent.com/) Ruby Client Library provides a simple Ruby interface for the [FreeAgent API 2.0](https://dev.freeagent.com/)
3+
This is a Ruby client library that provides a simple interface to the [FreeAgent API](https://dev.freeagent.com/). This
4+
is not an official FreeAgent project. It was created as a side project by one of our developers.
45

56
So what does this library have? Well the library wraps the API into a lovely little package providing rails-esque querying which makes it trivial to talk to FreeAgent.
67

78
Want all your draft invoices? Simple:
89
`Invoice.draft`
9-
10+
1011
Want to find all your contacts with open invoices?
11-
`Contact.open_clients`
12+
`Contact.open_clients`
1213

1314
Want to find your recurring expenses? Come on you’re not even making this hard anymore:
1415
`Expense.recurring`
15-
16+
1617
Important Notes
1718
---------------
18-
Please note the client is still a work in progress and is considered alpha.
19-
20-
Consequently, at this time it is advisable not to use this library in your development.
19+
This is a work in progress and is considered alpha. We warmly welcome pull requests from our developer community.
2120

2221
![tool](https://dev.freeagent.com/images/interface/masthead/masthead.png)
2322

2423
Todo
2524
--------------------
26-
* Finish all of the resources exposed by the API.
27-
* Tests
28-
* Documentation
29-
* Associations and nested resources
30-
* Dirty Attributes
25+
26+
- [ ] Finish all of the resources exposed by the API.
27+
- [ ] Tests
28+
- [ ] Documentation
29+
- [ ] Associations and nested resources
30+
- [ ] Dirty Attributes
3131

3232
Contributors
3333
------------

0 commit comments

Comments
 (0)