Skip to content
This repository has been archived by the owner on Oct 7, 2024. It is now read-only.

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nkokkos committed Jan 18, 2016
1 parent 136c4d6 commit e15cc6f
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# Vws (Vuforia Web Services ruby gem for API access for target management)

This is a ruby gem to interact with Vuforia web services api for managing the targets:
https://developer.vuforia.com/resources/dev-guide/managing-targets-cloud-database-using-developer-api
https://developer.vuforia.com/library//articles/Solution/How-To-Use-the-Vuforia-Web-Services-API

It uses the excellent rest-client (https://github.com/rest-client/rest-client) to handle the
HTTP/REST requests required by the Vuforia Web Services API.

## Installation from source:


Clone this repo onto your hard drive and cd into the root folder.


First install bundler gem (if it is not installed) by issuing:

gem install bundler
Expand All @@ -26,7 +24,6 @@ Build the vws gem by:

This will build the vws.gem into the pkg folder.


Install the gem from the pkg folder by:

gem install vws.gem
Expand Down Expand Up @@ -58,7 +55,7 @@ Instantiate a connection to the api with:
connection = Vws::Api.new("your_server_vws_access_key", "your_server_vws_secret_key")

After a successful connection, you should have access to the vuforia api as shown here:
https://developer.vuforia.com/library//articles/Solution/How-To-Use-the-Vuforia-Web-Services-API
https://developer.vuforia.com/library/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API

So, if you want to get a summary of the cloud database, you issue:

Expand Down Expand Up @@ -115,13 +112,7 @@ of the folder by issuing:
Setting a target from on to off and vice versa takes some time. It may take up to
0-10 minutes and it's based on Vuforia's infrastucture. It is your responsibilty
to poll for the changes on the target since no such feature has been implemented
in this gem.



## To do:

Implement some of the new vws apis
in this gem. More you can find here: https://developer.vuforia.com/library//articles/Best_Practices/Best-Practices-for-using-the-VWS-API

## Contributing

Expand Down

0 comments on commit e15cc6f

Please sign in to comment.