README.md in dexby-0.0.1 vs README.md in dexby-0.1.0
- old
+ new
@@ -1,10 +1,12 @@
# Dexby
[](https://travis-ci.org/jcantara/dexby)
-Dexcom API wrapper for Ruby
+Dexcom API wrapper for Ruby. Supply your dexcom username and password and get your real-time blood-glucose
+data from Dexcom for your own use outside of the phone apps or website. Useful for historic data archival and
+analysis; dashboards; etc.
Just so this is said right off: this software should NEVER be relied upon for medical use.
It is a toy project I am using to compile blood-glucode information for my own uses.
Please see the [MIT License](LICENSE) for specific details, but please, please never use this
for information you are trusting your life to. I would not trust my life on it and neither should you.
@@ -14,12 +16,18 @@
this way. Their API is not advertised as public, and is used by their own apps. I am not affiliated
with Dexcom in any way and do not represent them, nor does this library.
With that out of the way, we can get to the fun stuff:
-## Installation
+## Getting Started
+### Prerequisites
+
+Have a ruby installed on your system, we recommend RVM or RBEnv. Tests are run on MRI >2.2 and latest jruby, but should run on most rubies.
+
+### Installation
+
Add this line to your application's Gemfile:
gem 'dexby'
And then execute:
@@ -28,12 +36,29 @@
Or install it yourself as:
$ gem install dexby
-## Usage
+### Usage
-TODO: Write usage instructions here
+"#read" method takes optional `minutes` and `count` arguments for number of minutes backward in time to ask the API for, and maximum number
+of records to return
+
+```ruby
+require 'dexby'
+
+dex = Dexby.new('YourDexcomUsername','dexcomPassword12345')
+
+dex.read
+
+=> [{:trend=>:steady, :date=>#<DateTime: 2017-08-01T19:20:09-04:00 ((2457967j,84009s,920284537n),-14400s,2299161j)>, :value=>105}]
+```
+
+## Running tests
+
+Default rake task will run rspec tests:
+
+ $ bundle exec rake
## Contributing
1. Fork it ( https://github.com/jcantara/dexby/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)