StarMirror/gitpitch
1
0
Fork 0
mirror of https://github.com/gitpitch/gitpitch.git synced 2024-04-18 07:30:55 +08:00
Code Issues Projects Releases Wiki Activity

Updated README.

Browse Source
This commit is contained in:
David Russell 2016-08-11 20:25:28 +07:00
parent c86648e0f1
commit 861c960c43
1 changed files with 47 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -1,28 +1,59 @@
[![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/gitpitch/hello-world/master?t=white)
[![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/gitpitch/hello-world)
# Promote, Pitch, Or Present Your GitHub Projects
##GitPitch - Promote, Pitch, Or Present Your GitHub Projects
## What is GitPitch?
GitPitch is a service that turns **[PITCHME.md](https://gitpitch.com/#gitpitch-pitchme-markdown)** markdown into online, interactive slideshows. You can use it to promote, pitch or present anything, including your own GitHub projects.
1. [What Is GitPitch?](#what)
1. [What Is GitPitch For?](#purpose)
1. [GitPitch Samples](https://gitpitch.com/#gitpitch-pitchme-samples)
1. [Get Started (How-To Wiki)](https://github.com/gitpitch/gitpitch/wiki)
Each slideshow presentation is made instantly available online just as soon as you git-commit and push **PITCHME.md** on any branch within a public GitHub repo.
<a name="what" />
## What Is GitPitch?
![URL](images/gp-url.jpg)
GitPitch is a service that turns **PITCHME.md** markdown into online, interactive slideshows. You can use it to promote, pitch or present your GitHub projects.
## Is GitPitch for you?
Each slideshow presentation is made instantly available online just as soon as you *git-commit* and *push* **PITCHME.md** on any branch within a public GitHub repo.
If you ever find yourself needing to present a project, design, library, integration, framework, or solution:
####Slideshow @
- To colleagues, clients or customers
- Or at meetups or conferences
![TERM](images/gp-url.jpg)
Then GitPitch is for you. Simply capture your ideas in Markdown and let GitPitch automatically turn those ideas into compelling, responsive, online slideshow presentations.
<a name="purpose" />
## What Is GitPitch For?
## How does GitPitch work?
GitPitch makes it simple for GitHub developers to promote, pitch or present their GitHub projects. No more Keynote. No more PowerPoint. Just Markdown. Then Git-Commit.
![TERMINAL](images/gp-terminal.png)
![TERM](images/gp-terminal.png)
No more Keynote. No more PowerPoint. Just Markdown. Then git-commit on any branch within a public GitHub repo.
## GitPitch slideshow presentations are compelling
![SLIDESHOW](http://res.cloudinary.com/gitpitch/image/upload/github-integration/gp-slideshow-theme-style.png)
Each slideshow presentation is beautifully rendered, fully responsive, and highly interactive with a rich set of features including:
- [Markdown](https://github.com/gitpitch/gitpitch/wiki/Slide-Markdown) slides
- [Code](https://github.com/gitpitch/gitpitch/wiki/Code-Slides) and [GIST](https://github.com/gitpitch/gitpitch/wiki/GIST-Slides) slides
- [Image](https://github.com/gitpitch/gitpitch/wiki/Image-Slides) and [Video](https://github.com/gitpitch/gitpitch/wiki/Video-Slides) slides
- [Math Notation](https://github.com/gitpitch/gitpitch/wiki/Math-Notation-Slides) slides
- [Fragment](https://github.com/gitpitch/gitpitch/wiki/Fragment-Slides) slides
## GitPitch slideshow presentations are customizable
![SLIDESHOW](http://res.cloudinary.com/gitpitch/image/upload/github-integration/gp-slideshow-bg-style.png)
Choose between six distinct visual themes and further [customize the look and feel](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Settings) of your slideshow presentations using background images and your own logo.
## GitPitch slideshow presentations are social
GitPitch slideshow presentations are designed for sharing. You can:
- View any GitPitch presentation at its public URL
- [Promote](https://github.com/gitpitch/gitpitch/wiki/Slideshow-GitHub-Badge) any GitPitch presentation using a GitHub badge
- [Embed](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Embedding) any GitPitch presentation within a blog or website
- [Share](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Sharing) any GitPitch presentation on Twitter, LinkedIn, etc
- [Print](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Printing) any GitPitch presentation as PDF document
- [Download and present](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Offline) any GitPitch presentation offline
## GitPitch slideshow presentations just work
GitPitch requires no sign-up. And no configuration. Just add **PITCHME.md** ;)