/ml-streams

Primary LanguageXSLTApache License 2.0Apache-2.0

Contributors Forks Stargazers Issues MIT License LinkedIn


ML Streams

A machine vision video streaming project
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

  1. Get a free API Key at https://example.com
  2. Clone the repo 
    git clone https://github.com/grifhammer/ml-streams.git
  3. Install NPM packages 
    npm install

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Website Stuff
  • Backend Stuff
    • ML Stuff
    • Infra Stuff
  • README Updates
    • Make longer About The Project
    • Update Usage
    • Update Installation
    • Create Logo Image

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the Apache License. See LICENSE.txt for more information.

(back to top)

Contact

Griffin Hammer - grifhammer@gmail.com

Project Link: https://github.com/grifhammer/ml-streams

(back to top)