Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 2.34 KB

README.md

File metadata and controls

81 lines (57 loc) · 2.34 KB
Raw

ByteMarshall

A realtime collaborative runtime environment for your favourite programming languages

NPM Version Build Status Downloads Stats

Go to /editor path and it generates a session for you copy that url and share it with whoever your collaborating with. Check it out at https://bytemarshall.appspot.com/editor

Installation

OS X & Linux:

npm install my-crazy-module --save

Windows:

edit autoexec.bat

Usage example

A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.

For more examples and usage, please refer to the Wiki.

Development setup

Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.

make install
npm test

Release History

  • 0.2.1
    • CHANGE: Update docs (module code remains unchanged)
  • 0.2.0
    • CHANGE: Remove setDefaultXYZ()
    • ADD: Add init()
  • 0.1.1
    • FIX: Crash when calling baz() (Thanks @GenerousContributorName!)
  • 0.1.0
    • The first proper release
    • CHANGE: Rename foo() to bar()
  • 0.0.1
    • Work in progress

Meta

Your Name – @YourTwitter – YourEmail@example.com

Distributed under the XYZ license. See LICENSE for more information.

https://github.com/yourname/github-link

Contributing

  1. Fork it (https://github.com/yourname/yourproject/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request