Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a README for the spine-js-client library #13

Open
dpikhulya opened this issue Aug 13, 2018 · 0 comments
Open

Add a README for the spine-js-client library #13

dpikhulya opened this issue Aug 13, 2018 · 0 comments
Assignees
Labels
Client JS Issues related to the `spine-web-client` library

Comments

@dpikhulya
Copy link
Collaborator

dpikhulya commented Aug 13, 2018

A spine-js-client library would ideally need a README that would describe all of the things that a developer needs to know to get started using the client library, such as at least:

  • How do we attach it to our application (we need a Webpack build currently)?
  • The fact that we need to create an instance of BackendClient as a primary object for contacting the Spine backend.
    • Probably an example might be helpful here, e.g. here's how we are creating BackendClient in License Server web client: backend.js.
  • How do we fetch data?
  • How do we send commands?
  • A reference(s) to Spine Event Engine docs that have a description of the related concepts.

This README could be available in both the downloaded npm artifact, and the respective npm page.

See the other libraries for examples of what it can look like:

@dpikhulya dpikhulya added the Client JS Issues related to the `spine-web-client` library label Aug 13, 2018
@dpikhulya dpikhulya changed the title Add a README for spine-js-client library Add a README for the spine-js-client library Aug 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client JS Issues related to the `spine-web-client` library
Projects
None yet
Development

No branches or pull requests

2 participants