README.md

PlaceOS Crystal SDK

A library for building crystal applications that utilise PlaceOS.

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     placeos:
       github: placeos/crystal-client
       version: ~> 1.0

2. Run shards install

Usage

When initialialized via the host environment, the key PLACE_URI is expected.

Authentication

• from environment

  require "placeos"
  
  # Extracts user credentials from the following environment keys...
  # - PLACE_URI
  # - PLACE_EMAIL
  # - PLACE_PASSWORD
  # - PLACE_AUTH_CLIENT_ID
  # - PLACE_AUTH_SECRET
  client = PlaceOS::Client.from_environment_user

Development

Run crystal spec

Contributing

1. Fork it
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

Contributors

• Kim Burgess - creator and maintainer
• Caspian Baska - contributor and maintainer