Skip to content
This repository has been archived by the owner on Jun 8, 2018. It is now read-only.

Latest commit

 

History

History
56 lines (39 loc) · 2.45 KB

README.md

File metadata and controls

56 lines (39 loc) · 2.45 KB
Raw

Activity Stream SDK

The Activity Stream SDK is split up in to two components

  • as-sdk that contains core SDK files (this)
  • as-sdk-examples which contains reusable code and message examples

Both of these can be cloned and extended and pull-requests are welcome.

Getting started

It's a good start to read the Getting started guide but the examples also contains boilerplate code designed to get you off to a quick start. We want to grow our message examples directory, included in the examples, considerably and with your help. Please respect those messages as a guideline for you messages but keep in mind that you can extend or alter them at will.

The Activity Stream Message Schema

The Schema directory contains the schema for AS event and entity messages.

Importing the SDK into your project

Use these maven coordinates for Java*:

<dependency>
    <groupId>com.activitystream</groupId>
    <artifactId>as-sdk</artifactId>
    <version>0.1.25</version>
</dependency>

AS SDK will be available for other languages soon

SDK Design Principles

  • Keep as-sdk as light as possible by introducing the as few external dependencies as possible.
  • Build hand crafted versions for each supported programming language that suit it very well.
  • Create interface classes that uses the terminology of specific verticals/industries to make adoption easier for those that prefer it over the generic terminology used in the AS Message model.
  • Provide a wide range of examples tailored for specific verticals

Contact and support

Todo

  • Update the SDK so that it's based on the same Transportation classes as Core
  • Add utility functions that make it easier to work with the SDK in "detached" mode
  • Open source the as-sdk and unlock the github project
  • Add automatic building and maven releasing for this SDK
  • Open the as-sdk-examples repository
  • Add unit tests from core
  • Move the appropriate material/documentation from api.activitystream.com to here
  • Clean up the project so that different languages have project files likely to useful for that language