Merge pull request #56 from abyssoft/docs

Add some documentation

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: New issue for Bug Report
+about: "If you're sure it's reproducible and not just your machine: submit an issue so we can investigate."
+labels: "bug-report"
+---
+
+# Bug report
+
+<!-- Please fill these sections with the relevant information: -->
+
+## What you were trying to do (and why)
+
+<!-- replace me -->
+
+## What happened (include any debug output)
+
+<!-- replace me -->
+
+## What you expected to happen
+
+<!-- replace me -->
+
+## Step-by-step reproduction instructions
+
+<!-- replace me -->
+
+## Environment information
+
+__Server (Mac with keyboard and pointing device)__
+
+* Device: <!-- replace me -->
+* macOS version: <!-- replace me -->
+* Teleport version: <!-- replace me -->
+
+__Client (Mac being remotely controlled)__
+
+* Device: <!-- replace me -->
+* macOS version: <!-- replace me -->
+* Teleport version: <!-- replace me -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: New issue for Feature Request
+about: Share your idea or suggestion for a new feature for Teleport.
+labels: "feature-request"
+---
+
+# Feature request
+
+<!-- Please fill these sections with the relevant information: -->
+
+# A detailed description of the proposed feature
+
+<!-- replace me -->
+
+# The motivation for the feature
+
+<!-- replace me -->
+
+# How the feature would be relevant to at least 90% of Teleport users
+
+<!-- (if it's not: do not open a feature request) -->
+
+# What alternatives to the feature have been considered
+
+<!-- replace me -->
+
+<!-- We will close this issue or ask you to create a pull-request if it's something the maintainers are not actively planning to work on. -->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,9 @@
+---
+name: New issue for Question
+about: Ask about how to use, configure, or install Teleport.
+labels: "question"
+---
+
+# Question
+
+<!-- replace me -->

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+## How to contribute to Teleport
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/abyssoft/teleport/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/abyssoft/teleport/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and **reproduction steps** with expected and actual behavior.
+
+#### **Did you fix a bug?**
+
+* Open a new GitHub pull request.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+* Open a [Draft Pull Request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) early and include a description of your intended changes in the body.
+
+
+#### **Just looking to help out?**
+
+* Take a look through issues labeled [`help-wanted`](https://github.com/abyssoft/teleport/labels/help-wanted) for good places to start.
+
+* You can also take a look at open issues labeled [`bug`](https://github.com/abyssoft/teleport/labels/bug) or [`feature`](https://github.com/abyssoft/teleport/labels/feature).
+
+* More documentation is always welcome, send a pull request to the [`docs`](docs) directory.

README.md

@@ -1,2 +1,45 @@
-# teleport
-Virtual KVM for OS X
+# Teleport
+## A Virtual KVM for macOS
+
+Use one keyboard and pointing device to control multiple Macs.
+
+### Key Features
+
+* __Client__ - Control the keyboard and pointing device of another Mac.
+* __Server__ - Allow another Mac to control the system's keyboard and pointing device.
+* __Pasteboard Synchronization__ - Copy and paste across Macs.
+
+### Installation
+
+#### Manual
+
+1. Download the [latest release](https://github.com/abyssoft/teleport/releases/latest).
+2. Unzip the archive.
+3. Drag `Teleport.app` to `/Applications`.
+
+#### Homebrew
+
+```bash
+brew cask install abyssoft-teleport
+```
+
+### Project status
+
+Teleport is a legacy project that was once closed source. After the software was discontinued, the original author made the source available to the public and passionate users have been making things work on an ad-hoc basis.
+
+As of [`v1.2.2`](https://github.com/abyssoft/teleport/releases/tag/v1.2.2) All of the key features are known to work on macOS Big Sur.
+
+Teleport previously allowed for file drag and drop between Macs, encrypted network traffic, and status information displays. These features likely work right now, but are unsupported and subject to removal if they break.
+
+Our top priority is to keep the key features working smoothly on the lastest macOS operating system. We are not planning to add any new features, but [contributions are welcome](CONTRIBUTING.md).
+
+#### Current Maintainer
+
+__John Britton__ (@johndbritton)
+* [GitHub](https://github.com/johndbritton)
+* [Twitter](https://twitter.com/johndbritton)
+
+#### Original Author
+
+__Julien Robert__ (@abyssoft)
+* [GitHub](https://github.com/abyssoft)