Vulcan/README.md

24 lines
1.3 KiB
Markdown
Raw Normal View History

[![Build Status](https://travis-ci.org/TelescopeJS/Telescope.svg)](https://travis-ci.org/TelescopeJS/Telescope)
[![Code Climate](https://codeclimate.com/github/TelescopeJS/Telescope/badges/gpa.svg)](https://codeclimate.com/github/TelescopeJS/Telescope)
2012-09-20 16:03:14 +09:00
Telescope is an open-source, real-time social news site built with [Meteor](http://meteor.com)
**Note:** Telescope is beta software. Most of it should work but it's still a little unpolished and you'll probably find some bugs. Use at your own risk :)
2014-08-06 12:15:35 +09:00
Note that Telescope is distributed under the [MIT License](http://opensource.org/licenses/MIT)
2014-08-06 12:12:49 +09:00
2015-05-21 16:31:37 +09:00
### Getting Started
2014-08-28 08:06:26 +09:00
2015-05-21 16:31:37 +09:00
Note that while simply cloning this repository will work, it is recommended you clone the [sample project](https://github.com/TelescopeJS/sample-project/) repository instead for a simpler workflow.
2014-08-28 08:06:26 +09:00
2015-05-21 16:31:37 +09:00
Please refer to [the documentation](http://telescope.readme.io/v0.20/docs/installing-telescope) for more instructions on installing Telescope.
2014-08-28 08:06:26 +09:00
2014-08-06 12:15:35 +09:00
### Learn More
2014-08-06 12:12:49 +09:00
2015-05-21 10:17:45 +09:00
- [Homepage](http://telescopeapp.org)
- [Demo](http://demo2.telescopeapp.org)
- [Sample Project](https://github.com/TelescopeJS/sample-project/)
- [Documentation](http://telescope.readme.io)
- [Roadmap](https://trello.com/b/oLMMqjVL/telescope-roadmap)
2015-05-21 16:31:37 +09:00
- [Slack](http://slack.telescopeapp.org/)
- [Meta](http://meta.telescopeapp.org/) Discussions about Telescope