Giter Club home page Giter Club logo

sotory's People

Contributors

kevanantha avatar r17x avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

sotory's Issues

Create usage instruction in Readme

We don't provide yet on how to use this library on your project. Although there are demo directory, I think having clear usage instruction in README.md is the best choice.

Basically to use this library, all you need is to create configuration object configuration like this:

interface IConfig {
  storyLength: number // length of each story, in milisecond
  endpoint: string // the source of your story data
  avatar: string // the avatar that displaying your story
  identifier?: string // not used yet, maybe we need to remote it?
  target: string // target dom element to display the avatar. Should be `id`.
}

example:

const config: IConfig = {
  storyLength: 5000,
  endpoint: 'https://jsonbox.io/box_54808b72dbcf8f9b24f7',
  avatar: 'https://avatars0.githubusercontent.com/u/43804217?v=4',
  identifier: 'evilfactorylabs',
  target: '#js-sotory'
}

After that we need to instantiate the object (with config as a parameter) and call the init method from it.

const sotory = new Sotory(config)

sotory.init()

That's it! You can use your own instruction style by following above style.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.