updated README.md

README.md

@@ -1,47 +1,14 @@
-# FitbitAgent
+# Create events from Fitbit activities
 
-Welcome to your new agent gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/huginn_fitbit_agent`. To experiment with that code, run `bin/console` for an interactive prompt.
+OAUTHv2 client and secret can be specified in the configuration of the
+  agent or globally using `ENV['FITBIT_OAUTH2_CLIENT']` and
+  `ENV['FITBIT_OAUTH2_SECRET']`.
 
-TODO: Delete this and the text above, and describe your gem
+The agent will remember some (`loopback`=50) activities so it can update
+  them instead of creating new ones.
 
-## Installation
+Refer to [this page](https://dev.fitbit.com/build/reference/web-api/activity/#get-activity-logs-list)
+  for a list of properties of the events created.
 
-This gem is run as part of the [Huginn](https://github.com/huginn/huginn) project. If you haven't already, follow the [Getting Started](https://github.com/huginn/huginn#getting-started) instructions there.
-
-Add this string to your Huginn's .env `ADDITIONAL_GEMS` configuration:
-
-```ruby
-huginn_fitbit_agent
-# when only using this agent gem it should look like this:
-ADDITIONAL_GEMS=huginn_fitbit_agent
-```
-
-And then execute:
-
-    $ bundle
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-Running `rake` will clone and set up Huginn in `spec/huginn` to run the specs of the Gem in Huginn as if they would be build-in Agents. The desired Huginn repository and branch can be modified in the `Rakefile`:
-
-```ruby
-HuginnAgent.load_tasks(branch: '<your branch>', remote: 'https://github.com/<github user>/huginn.git')
-```
-
-Make sure to delete the `spec/huginn` directory and re-run `rake` after changing the `remote` to update the Huginn source code.
-
-After the setup is done `rake spec` will only run the tests, without cloning the Huginn source again.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/huginn_fitbit_agent/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+After the agent is created go into its description to complete the OAUTHv2
+  flow and authorize it to read your Fitbit data.

huginn_fitbit_agent.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "huginn_fitbit_agent"
-  spec.version       = '1.0.3'
+  spec.version       = '1.0.4'
   spec.authors       = ["Alessio Signorini"]
   spec.email         = ["[email protected]"]