This commit is contained in:
Jon Rohan 2018-04-10 16:31:41 -07:00
parent e60d555875
commit cbfdaec623
3 changed files with 36 additions and 26 deletions

30
LICENSE
View File

@ -1,15 +1,21 @@
ISC License The MIT License (MIT)
Copyright (c) , JasonEtco <jasonetco@gmail.com> Copyright (c) 2018 GitHub Inc.
Permission to use, copy, modify, and/or distribute this software for any Permission is hereby granted, free of charge, to any person obtaining a copy
purpose with or without fee is hereby granted, provided that the above of this software and associated documentation files (the "Software"), to deal
copyright notice and this permission notice appear in all copies. in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES The above copyright notice and this permission notice shall be included in all
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF copies or substantial portions of the Software.
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -1,15 +1,19 @@
# figmadiffer # Figma Image Diff probot
> a GitHub App built with [probot](https://github.com/probot/probot) that > a GitHub App built with [probot](https://github.com/probot/probot) that checks before and after components between two Figma files and posts before after images.
## Setup ![image](https://user-images.githubusercontent.com/54012/38582457-a76db572-3cc4-11e8-8b95-34345c8beab8.png)
```sh ## Usage
# Install dependencies
npm install
# Run the bot This probot is customized to work with [Octions](https://github.com/primer/octicons) to look for changes in the figma import url found in the octicons package.json.
npm start
```
See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this app. When there is a change in the url, this bot will pull down images for the before and after files and generate a before and after image for any changed components.
## Documentation
The documentation for writing your own Probot can be [found on the probot website](https://probot.github.io/).
## License
[MIT](./LICENSE) &copy; [GitHub](https://github.com/)

View File

@ -1,10 +1,10 @@
{ {
"name": "figmadiffer", "name": "@github/figma-diff-probot",
"private": true,
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"author": "JasonEtco <jasonetco@gmail.com>", "license": "MIT",
"license": "ISC", "repository": "https://github.com/primer/figma-diff-probot.git",
"repository": "https://github.com/JasonEtco/figmadiffer.git",
"scripts": { "scripts": {
"start": "probot run ./index.js", "start": "probot run ./index.js",
"test": "jest && standard" "test": "jest && standard"