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

Document public interface #21

Open
3 tasks
starsinmypockets opened this issue Aug 27, 2019 · 0 comments
Open
3 tasks

Document public interface #21

starsinmypockets opened this issue Aug 27, 2019 · 0 comments

Comments

@starsinmypockets
Copy link
Contributor

As a user I want to know how to use this library so I can use it

Acceptance

  • New user can instantiate component from docs

Tasks

  • Figure out what the public interface is and document in analysis section, below
  • Add quick public interface to docs

Analysis

Something like:

Getting started

In index.js:

import React from 'react'
import ReactDom from 'react-dom'
import DataView from ''datapackage-views-js"

ReactDom.render(<DataView datapackge={views: {resource: [{a: 1, b: 2}, {a: 2, b:2}, specType: 'table', title: 'Linear data']} />, // get el)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant