Skip to content

Commit

Permalink
update readme a little bit
Browse files Browse the repository at this point in the history
  • Loading branch information
handsomematt committed Dec 6, 2016
1 parent 3d5a169 commit 99c0d9b
Showing 1 changed file with 18 additions and 22 deletions.
40 changes: 18 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
# Pointshop
[![](https://img.shields.io/github/stars/adamdburton/pointshop.svg?style=social&label=Star)]()
[![](https://img.shields.io/github/issues-raw/adamdburton/pointshop.svg)]()
[![](https://img.shields.io/github/release/adamdburton/pointshop.svg)]()
[![](https://img.shields.io/github/license/adamdburton/pointshop.svg)]()

Pointshop is a shop system for Garry's Mod, created and maintained by [Adam '_Undefined' Burton](http://burt0n.net/) and ['Handsome' Matt Stevens](http://handsomematt.co.uk).
## Synopsis

Pointshop is a shop system for Garry's Mod, created by [Adam '_Undefined' Burton](https://github.com/adamdburton) and maintained by ['Handsome' Matt Stevens](https://github.com/HandsomeMatt).

## Quick start

Two quick start options are available:

* [Download the latest release](https://github.com/adamdburton/pointshop/releases/tag/v1.0.0).
* Clone the repo: `git clone https://github.com/adamdburton/pointshop.git`.
* [Download the latest tarball](https://github.com/adamdburton/pointshop/archive/master.zip). (*same as git clone, without the git*)
* [Download the latest stable release](https://github.com/adamdburton/pointshop/releases). (*can be out of date*)
* Clone the repo: `git clone https://github.com/adamdburton/pointshop.git`. (*best way to stay up to date*)

## Bugs and feature requests

Have a bug or a feature request? [Please open a new issue](https://github.com/adamdburton/pointshop/issues). Make sure you follow our [contributing guidelines](https://github.com/adamdburton/pointshop/blob/master/CONTRIBUTING.md).
* Have a bug or a feature request? [Please open a new issue](https://github.com/adamdburton/pointshop/issues). Make sure you follow our [contributing guidelines](https://github.com/adamdburton/pointshop/blob/master/CONTRIBUTING.md).
* Have a question that's not a feature request or bug report? [Ask on the Facepunch thread.](http://facepunch.com/threads/1286577)

## Documentation

Expand All @@ -21,19 +28,9 @@ http://pointshop.burt0n.net

Please read through our [contributing guidelines](https://github.com/adamdburton/pointshop/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.

## Community

* Follow [@adamdburton on Twitter](https://twitter.com/adamdburton).
* Follow [@_HandsomeMatt on Twitter](https://twitter.com/_HandsomeMatt).
* Have a question that's not a feature request or bug report? [Ask on the Facepunch thread.](http://facepunch.com/threads/1286577)

## Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Pointshop will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

`<major>.<minor>.<patch>`
Pointshop is maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format: `<major>.<minor>.<patch>`

And constructed with the following guidelines:

Expand All @@ -48,15 +45,14 @@ For more information on SemVer, please visit [http://semver.org/](http://semver.
**Adam '_Undefined' Burton**

+ [http://burt0n.net](http://burt0n.net/)
+ [http://twitter.com/adamdburton](http://twitter.com/adamdburton)
+ [http://github.com/adamdburton](http://github.com/adamdburton)
+ [https://twitter.com/adamdburton](https://twitter.com/adamdburton)
+ [https://github.com/adamdburton](https://github.com/adamdburton)

**'Handsome' Matt Stevens**

+ [http://handsomematt.co.uk](http://handsomematt.co.uk)
+ [http://twitter.com/_HandsomeMatt](http://twitter.com/_HandsomeMatt)
+ [http://github.com/HandsomeMatt](http://github.com/HandsomeMatt)
+ [https://github.com/HandsomeMatt](https://github.com/HandsomeMatt)
+ [https://twitter.com/_HandsomeMatt](https://twitter.com/_HandsomeMatt)

## Copyright and license

Copyright 2014 Adam Burton under [the MIT license](LICENSE).
Copyright 2014-2016 Adam Burton under [the MIT license](LICENSE).

0 comments on commit 99c0d9b

Please sign in to comment.