Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to reflect current state of WebExtension #267

Merged
merged 4 commits into from
Jul 26, 2017
Merged

Conversation

lidel
Copy link
Member

@lidel lidel commented Jul 22, 2017

This PR replaces legacy README with new version, that reflects current state of WebExtension port.
It updates screenshot, adds new features such as Quick Upload and provides installation instructions for browsers other than Firefox.

Keep in mind that English is not my native language – I've learned it by watching old TV shows 🙃
Would be great if multiple people looked at README and pitched-in fixes/suggestions in exchange for imaginary cake 🍰 ✨

@lidel lidel added the kind/maintenance Work required to avoid breaking changes or harm to project's status quo label Jul 22, 2017
@lidel lidel added this to the v2.0.0 milestone Jul 22, 2017
@lidel lidel self-assigned this Jul 22, 2017
@lidel lidel requested a review from a team July 22, 2017 17:04
README.md Outdated
@@ -37,39 +32,66 @@ It aims to make the web faster, safer, and more open.

Learn more at: https://ipfs.io (It is really cool, I promise!)

## Features
## Features

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trailing whitespace

README.md Outdated
Install the latest signed release from [AMO](https://addons.mozilla.org/en-US/firefox/addon/ipfs-gateway-redirect/):

[![Get the add-on](https://blog.mozilla.org/addons/files/2015/11/AMO-button_1.png)](https://addons.mozilla.org/en-US/firefox/addon/ipfs-gateway-redirect/)

It will guarantee automatic updates to the latest version reviewed by Mozilla community.

#### Old Firefox (< 53) and XUL-compatible browsers

Legacy versions `1.x.x` were based on currently deprecated Add-On SDK (Firefox-only).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double spaces.


"description": "Access IPFS resources via custom HTTP2IPFS gateway",
"description": "WebExtension that simplifies access to IPFS resources",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lidel lidel mentioned this pull request Jul 22, 2017
9 tasks
Copy link
Member

@daviddias daviddias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, wow! This is a very big announcement! :D Thanks for keeping pushing hard at this @lidel :D

Overall the README LGTM :)

@lidel lidel merged commit eca9940 into master Jul 26, 2017
@lidel lidel deleted the readme-updates branch July 26, 2017 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/maintenance Work required to avoid breaking changes or harm to project's status quo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants