From b000e7093c2e08fdde699493f1b94c7f4519dc88 Mon Sep 17 00:00:00 2001 From: Michael Fix Date: Thu, 14 May 2020 20:45:43 -0700 Subject: [PATCH] Improve README docs (#1005) * remove old badges * improve features on README * tweaks --- README.md | 57 +++++++++++++++++++++++++++----------------- docs/README.br.pt.md | 11 +-------- docs/README.cn.zh.md | 13 ++-------- docs/README.de.md | 2 +- docs/README.fr.md | 11 +-------- docs/README.hi.md | 3 +-- docs/README.ja.md | 6 +---- docs/README.kr.md | 3 +-- docs/README.ml.md | 3 +-- docs/README.ta.md | 3 +-- docs/README.tr.md | 3 +-- 11 files changed, 46 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index cf965ce..1f35ace 100644 --- a/README.md +++ b/README.md @@ -15,16 +15,6 @@ FOSSA Status -

@@ -102,10 +92,10 @@ You know [all](https://twitter.com/dan_abramov/status/890191815567175680) [of](h ## Features -- **Customization**. Customize things like your image's syntax theme, window style, and more +- **Customization**. Customize things like your image's syntax theme, font style, and more - **Share quickly**. Save your image or a link with one click -- **Import from GitHub gist**. Simply append a GitHub gist id to the url +- **Save snippets**. Create an account to save snippets for later. Shared snippets are automatically unfurled on Twitter and Slack. ## Usage @@ -114,28 +104,50 @@ You know [all](https://twitter.com/dan_abramov/status/890191815567175680) [of](h There are a few different ways to import code into Carbon: - Drop a file onto the editor -- Append a GitHub gist id to the url (e.g. `carbon.now.sh/GIST_ID_HERE`) -- Paste your code directly +- Append a GitHub gist ID to the URL (e.g. [`carbon.now.sh/`](https://carbon.now.sh/3208813b324d82a9ebd197e4b1c3bae8)) +- Or just start typing! #### Customization -Once you've got all of your code into Carbon, you can customize your image by changing the syntax theme, background color, window theme, or padding. +Once you've got all of your code into Carbon, you can customize your image by changing the syntax theme, background color, window theme, padding, shadows, fonts, and more. + +#### Exporting & Sharing + +After you've customized your image you can share your snippet in a number of ways + +##### Create a saved snippet + +Sharing a saved snippet will automatically unfurl the image on platforms like Twitter and Slack. This lets users see your creation, while also giving them access to the source code via the link. Better yet, if you need to make an update, simply follow the link yourself to edit the snippet directly. -#### Export/Sharing +To create a saved snippet: -After you've customized your image you can either Tweet a link to the image, or save it directly. +1. Login using the "Sign in/Sign up" button +2. Edit as you normally woud — your snippet will get saved automatically +3. Copy the URL from your browser window and share away! -If you use the 'Tweet' button, Carbon will automatically make your image accessible. However, if you want to manually tweet your image, please check out [how to make your Twitter images accessible](https://help.twitter.com/en/using-twitter/picture-descriptions). +##### Embed a snippet -If you include a Carbon image in a post, the source code will be invisible for assistive technology, it will not be possible to enlarge it or copy it, etc. Please, think about adding another element with the source code as text, like an [HTML Details Element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details) below the image. +This is the recommended method sharing Carbon on your own website or blog. Readers can even copy the code with the click of a button. + +You can embed any Carbon snippet in your website directly using the `carbon.now.sh/embed` URL. The "Copy Menu" lets you quickly copy the correct iFrame snippet, or the encoded URL for embedding on platforms like Medium. + +Finally, you can also embed saved snippets or GitHub gists using `carbon.now.sh/embed/:id`. + +##### Use the Tweet button + +The Tweet button will not only share the image on Twitter, but it will also correctly encode the `alt` text to ensure your images are accessible. However, if you want to tweet image yourself, please check out [how to make your Twitter images accessible](https://help.twitter.com/en/using-twitter/picture-descriptions). + +##### Download the image directly + +Carbon supports downloading your image as a PNG and SVG. You can also click `Export → Open` to open your image directly in the browser. Finally, you can copy the Carbon image directly to your clipboard by going to `Copy → Image`. #### Installing Carbon for Desktop (Offline) If you are using Google Chrome, or another browser that supports Progressive Web Apps, you can install Carbon for use offline by: -1. Visiting [https://carbon.now.sh](https://carbon.now.sh) -2. Clicking your browser's settings menu -3. Clicking "Install Carbon..." +1. Visit [carbon.now.sh](https://carbon.now.sh) +2. Click your browser's settings menu +3. Click "Install Carbon..." ## Community @@ -328,4 +340,5 @@ Thanks goes out to all these wonderful people ([emoji key](https://github.com/ke + diff --git a/docs/README.br.pt.md b/docs/README.br.pt.md index bc2a643..16b70ef 100644 --- a/docs/README.br.pt.md +++ b/docs/README.br.pt.md @@ -15,16 +15,6 @@ FOSSA Status -

@@ -219,4 +209,5 @@ Agradecemos imensamente a todas essas pessoas maravilhosas pela grande ajuda ([e + diff --git a/docs/README.cn.zh.md b/docs/README.cn.zh.md index cd02e66..2dc7b59 100644 --- a/docs/README.cn.zh.md +++ b/docs/README.cn.zh.md @@ -15,16 +15,6 @@ FOSSA Status -

@@ -143,7 +133,7 @@ ##### 编辑器插件 - [IntelliJ IDEA `carbon-now-sh`](https://plugins.jetbrains.com/plugin/10469-carbon-now-sh) - 在 IntelliJ IDEA 中通过右键菜单导入选中的代码到 Carbon -- [Atom `carbon-now-sh`](https://atom.io/packages/carbon-now-sh) - 在 Atom 中通过 `shift-cmd-A` 快捷键导入当前文件到 Carbon +- [Atom `carbon-now-sh`](https://atom.io/packages/carbon-now-sh) - 在 Atom 中通过 `shift-cmd-A` 快捷键导入当前文件到 Carbon - [VS Code `carbon-now-sh`](https://marketplace.visualstudio.com/items?itemName=ericadamski.carbon-now-sh) - 在 VS Code 中通过 `carbon` 命令导入当前文件到 Carbon - [Sublime Text 3 `carbon-now-sh`](https://github.com/molnarmark/carbonSublime) - 在 Sublime Text 3 中通过自定义快捷键导入选中的代码到 Carbon - [Vim `carbon-now-sh`](https://github.com/kristijanhusak/vim-carbon-now-sh) - 在 Vim/Neovim 中通过 `CarbonNowSh()` 函数导入选中的代码到 Carbon @@ -326,4 +316,5 @@ Carbon 项目由 TA 们发起： + diff --git a/docs/README.de.md b/docs/README.de.md index 6cc7e05..082c896 100644 --- a/docs/README.de.md +++ b/docs/README.de.md @@ -5,7 +5,6 @@ [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) [![MIT License](https://img.shields.io/github/license/carbon-app/carbon.svg)](https://github.com/carbon-app/carbon/blob/master/LICENSE) [![Greenkeeper badge](https://badges.greenkeeper.io/carbon-app/carbon.svg)](https://greenkeeper.io/) -[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/carbon-now)

## Einführung @@ -186,4 +185,5 @@ Ein Danke geht an all diese wunderbaren Menschen ([emoji key](https://github.com + diff --git a/docs/README.fr.md b/docs/README.fr.md index c2b9406..9b41ef7 100644 --- a/docs/README.fr.md +++ b/docs/README.fr.md @@ -15,16 +15,6 @@ FOSSA Status -

@@ -224,4 +214,5 @@ Merci à toutes ces personnes merveilleuses ([emoji key](https://github.com/kent + diff --git a/docs/README.hi.md b/docs/README.hi.md index 81d5eb0..cf0b832 100644 --- a/docs/README.hi.md +++ b/docs/README.hi.md @@ -4,8 +4,6 @@ [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) [![MIT License](https://img.shields.io/github/license/carbon-app/carbon.svg)](https://github.com/carbon-app/carbon/blob/master/LICENSE) -[![Greenkeeper badge](https://badges.greenkeeper.io/carbon-app/carbon.svg)](https://greenkeeper.io/) -[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/carbon-now)

## प्रस्तावना @@ -186,4 +184,5 @@ PRs का स्वागत है! अधिक जानकारी के + diff --git a/docs/README.ja.md b/docs/README.ja.md index fdf9d87..3ad9683 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -15,11 +15,6 @@ Greenkeeper badge - - Join the community on Spectrum - - - FOSSA Status



@@ -213,4 +208,5 @@ Carbon は次の人々によるプロジェクトです: + diff --git a/docs/README.kr.md b/docs/README.kr.md index d795cee..c914cc6 100644 --- a/docs/README.kr.md +++ b/docs/README.kr.md @@ -4,8 +4,6 @@ [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) [![MIT License](https://img.shields.io/github/license/carbon-app/carbon.svg)](https://github.com/carbon-app/carbon/blob/master/LICENSE) -[![Greenkeeper badge](https://badges.greenkeeper.io/carbon-app/carbon.svg)](https://greenkeeper.io/) -[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/carbon-now)

## Introduction @@ -188,4 +186,5 @@ Carbon is a project by + diff --git a/docs/README.ml.md b/docs/README.ml.md index 56a45a0..b652a0e 100644 --- a/docs/README.ml.md +++ b/docs/README.ml.md @@ -4,8 +4,6 @@ [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) [![MIT License](https://img.shields.io/github/license/carbon-app/carbon.svg)](https://github.com/carbon-app/carbon/blob/master/LICENSE) -[![Greenkeeper badge](https://badges.greenkeeper.io/carbon-app/carbon.svg)](https://greenkeeper.io/) -[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/carbon-now)

## ആമുഖം @@ -186,4 +184,5 @@ PR കൾ സ്വാഗതം ചെയ്യുന്നു! കൂടുത + diff --git a/docs/README.ta.md b/docs/README.ta.md index 48fd70a..94a8ca4 100644 --- a/docs/README.ta.md +++ b/docs/README.ta.md @@ -4,8 +4,6 @@ [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) [![MIT License](https://img.shields.io/github/license/carbon-app/carbon.svg)](https://github.com/carbon-app/carbon/blob/master/LICENSE) -[![Greenkeeper badge](https://badges.greenkeeper.io/carbon-app/carbon.svg)](https://greenkeeper.io/) -[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/carbon-now)

## முன்னுரை @@ -192,4 +190,5 @@ PR வரவேற்கிறோம்! மேலும் தகவலுக + diff --git a/docs/README.tr.md b/docs/README.tr.md index 9083ec8..435fce7 100644 --- a/docs/README.tr.md +++ b/docs/README.tr.md @@ -4,8 +4,6 @@ [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) [![MIT License](https://img.shields.io/github/license/carbon-app/carbon.svg)](https://github.com/carbon-app/carbon/blob/master/LICENSE) -[![Greenkeeper badge](https://badges.greenkeeper.io/carbon-app/carbon.svg)](https://greenkeeper.io/) -[![Spectrum'a katılın](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/carbon-now)

## Giriş @@ -186,4 +184,5 @@ Bu muhteşem insanlara teşekkürler ([emoji key](https://github.com/kentcdodds/ +