forked from nikmd23/ossperks
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated readme.md to account for new YAML based process
- Loading branch information
Showing
1 changed file
with
22 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,34 @@ | ||
| # OSS Perks | ||
| A listing of tools & services freely available to open source projects at [ossPerks.com](http://ossperks.com/) | ||
|  | ||
| --- | ||
| A listing of tools & services freely available to open source projects at [ossPerks.com](http://ossperks.com/). | ||
| For updates, be sure to follow [@ossPerks](https://twitter.com/ossperks) on Twitter. | ||
|
|
||
| ## How to Add Your Favorite Perk | ||
| * Fork the repository | ||
| * Use the following template to create an additional perk. | ||
| * Use the following [YAML](http://www.yaml.org/) template to create an additional perk. | ||
|
|
||
| ```html | ||
| <li> | ||
| <div class="product-overview"> | ||
| <div class="product-title"> | ||
| <h2><a href="{URL to Tool/Service Page}">{Name of Tool/Service}</a></h2> | ||
| by <div class="tag company"><a href="{URL to Vendor Site}">{Name of Vendor}</a></div> | ||
| </div> | ||
| <div class="tag platform">{Platform}</div> | ||
| </div> | ||
| <div class="product-description"> | ||
| {Description of Tool/Service} | ||
| </div> | ||
| <div class="tag category">{Category Tag}</div> <!-- This node can be repeated for multiple tags --> | ||
| <div class="clear"></div> | ||
| </li> | ||
| ```yml | ||
| #name of the product/service & the uri to apply for a license | ||
| - perk: {name: GitHub, uri: 'http://github.com/'} | ||
| #product/service description | ||
| description: Powerful collaboration, review, and code management for open source and private development projects. | ||
| #categories the produce/service fits in | ||
| categories: [Source Control, Issue Management] | ||
| #the development platform the product/service is for | ||
| platforms: [Any] | ||
| #name of the product/service vendor & the uri to their site | ||
| company: {name: GitHub, uri: 'http://github.com/'} | ||
| ``` | ||
| * Add the results to the `<ul class="product-listing reset">` within `<section class="products">` on `index.html`. | ||
| * Make a pull request | ||
| * Add the results to the `perks:` list at the top of `index.html`. | ||
| * Submit a pull request | ||
|
|
||
| ### Notes | ||
|
|
||
| * Try to use `{URL to Tool/Service Page}` that points to information about what is needed to qualify for a free license. | ||
| * `{Platform}` is a development platform like `.Net`, `Java`, `JavaScript` or `Ruby`. | ||
| * For non-platform specific tools, enter `any`, not an operating system. | ||
| * Try to use `{URL to Product/Service Page}` that points to information about what is needed to qualify for a free license. | ||
| * `platforms:` is a development platform like `.net`, `Java`, `JavaScript` or `Ruby`. | ||
| * For non-platform specific tools, enter `Any`, not an operating system. | ||
|
|
||
| ## About ossperks.com | ||
| The long rerm plan is to build something big and beautiful that provides value for open source projects, consisting of | ||
| The long term plan is to build something big and beautiful that provides value for open source projects, consisting of | ||
| a community edited information source. But for starters we're keeping it simple while taking the pulse of the | ||
| community. Is there any interest? What are the needs? |