Update ToC with details

This commit is contained in:
karthikvgupta
2015-11-10 12:52:12 +05:30
parent 2647c37720
commit cfc7443e87

View File

@@ -4,25 +4,81 @@
[![wercker status](https://app.wercker.com/status/85bee6f48800554f27ff573ebc85a57c/m/master "wercker status")](https://app.wercker.com/project/bykey/85bee6f48800554f27ff573ebc85a57c) [![wercker status](https://app.wercker.com/status/85bee6f48800554f27ff573ebc85a57c/m/master "wercker status")](https://app.wercker.com/project/bykey/85bee6f48800554f27ff573ebc85a57c)
## Table of contents ## Table of Contents
* [About One MDM](#about-one-mdm) * [About OneMDM](#about-one-mdm)
* [Quick start](#quick-start) * [Quick Start](#quick-start)
* [Features](#features) * [Features](#features)
* [Bugs and feature requests](#bugs-and-feature-requests) * [Bugs and Feature Requests](#bugs-and-feature-requests)
* [Contributing](#contributing) * [Contributing](#contributing)
* [Copyright and license](#copyright-and-license) * [Copyright and License](#copyright-and-license)
## About One MDM ## About OneMDM
One MDM is an open source Mobile Device Management (MDM) solution. One MDM can manage widely distributed android devices which are enrolled in the One MDM server after installing One MDM client on these devices. OneMDM is an open source Mobile Device Management (MDM) solution. OneMDM can manage widely distributed android devices which are enrolled in the OneMDM server after installing OneMDM client on these devices.
## Quick start ## Quick start
## Features ## Features
## Bugs and feature requests Features which are currently available :
* **Tracking Device Status**
Track online/offline status of the device in the admin console.
* **Update OneMDM Client App**
Send notification to registered devices for updating the OneMDM Client.
## Bugs and Feature Requests
Looking to contribute something to OneMDM? **Here's how you can help.**
Please take a moment to read the below information in order to make the contribution process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
### Feature Requests
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
### Bug Reports
A bug is a _demonstrable problem_ that is caused by the code in the repository.
Good bug reports are extremely helpful, so thanks!
Guidelines for bug reports:
0. **Use the GitHub issue search** — check if the issue has already been
reported.
1. **Check if the issue has been fixed** — try to reproduce it using the
latest `master` or development branch in the repository.
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
Example:
> Short and descriptive example bug report title
>
> A summary of the issue and the browser/OS environment in which it occurs. If
> suitable, include the steps required to reproduce the bug.
>
> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.
>
>
> Any other information you want to share that is relevant to the issue being
> reported. This might include the lines of code that you have identified as
> causing the bug, and potential solutions (and your opinions on their
> merits).
## Contributing ## Contributing
## Copyright and license If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request.
When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles by running mvn clean verify.
## Copyright and License