Giter Club home page Giter Club logo

veritone-sdk's Introduction

veritone-sdk

this is a monorepo managed by Yarn's workspaces feature (https://yarnpkg.com/blog/2017/08/02/introducing-workspaces/).

Documentation

Heavily WIP docs/examples for the various packages are available at https://veritone.github.io/veritone-sdk

Development

if you don't have yarn, install it here: https://yarnpkg.com/en/docs/install

yarn install in either the veritone-sdk root, or an individual project's directory. packages can be yarn published to npm from their own root directory.

Releasing

This is WIP and may change as we find a better process

  1. Complete your feature and PR it to the master branch.
  2. Once merged, update package.json in each affected folder under the packages directory
    • Increment the version field using semver
  3. Update each package's CHANGELOG file with your new version.
  4. Commit the package.json and CHANGELOG changes (only!) to master.
  5. Tag the commit as a release. Create a release for each package you updated, using the naming scheme:
    • Tag version: version-packagename, ie. 1.0.0-veritone-client-js
    • Release title: packagename vVersion, ie. veritone-client-js v1.0.0
  6. On your local machine, checkout the master branch and git pull.
  7. Run npm publish in each package directory as needed to push your release to NPM.

License

Copyright 2017, Veritone Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

veritone-sdk's People

Contributors

chrispelletier avatar codisms avatar olslash avatar linfongi avatar atungw avatar nimajalali avatar mezzi avatar tblanche avatar rongzhu avatar atb91590 avatar mdle avatar deloreanz avatar jacksontbryan avatar 1heiggins avatar steveshaffer avatar jonheinze avatar derekrliang avatar jtveritone avatar shsing2000 avatar

Watchers

James Cloos avatar  avatar

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.