Added headers, improved badges, updated FAQs, removed logo, added Doc…

…umentation dir Todo - check links
PABourdais · Apr 7, 2021 · 02ae81d · 02ae81d
1 parent ee36fb9
commit 02ae81d
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 19 deletions.
diff --git a/ARGUMENTS.md → Documentation/ARGUMENTS.md b/ARGUMENTS.md → Documentation/ARGUMENTS.md
@@ -1,5 +1,12 @@
+##Custom arguments
+
+Raycast allows you to set custom input fields into your script to enable you to do things like set items on a todo list or search google for specified terms.
+
+
+Use `argument[1..3]` metadata to specify custom arguments that will be displayed as inputs in the search bar when the script is selected.
+
 ![Custom arguments](./images/screenshots/custom-arguments.png)
-Use `argument[1..3]` metadata to specify custom arguments that will be displayed as inputs in the search bar when the script is selected. The value of the argument metadata parameter should be valid json with these fields:
+ The value of the argument metadata parameter should be valid json with these fields:
 | Field | Description | Required | App Version |
 | ----- | ----------- | -------- | ----------- |
 | type | Input type. For now only "text" value available. | ✅ | 1.2.0+ |

diff --git a/CONTRIBUTING.md → Documentation/CONTRIBUTING.md b/CONTRIBUTING.md → Documentation/CONTRIBUTING.md
diff --git a/outputModes.md → Documentation/OUTPUTMODES.md b/outputModes.md → Documentation/OUTPUTMODES.md
@@ -1,3 +1,7 @@
+##Output modes
+
+Here, you can browse the range of ways that Raycast lets you view your data, whether you need to display a range of items such as open pull requests, or whether you just need confirmation that your script has run successfully.
+
 In `fullOutput` the entire output is presented on a separate view, similar to a terminal window. This is handy when your script generates output to consume.
 
 ![fullOutput mode](./images/screenshots/fulloutput.png)

diff --git a/README.md → Documentation/README.md b/README.md → Documentation/README.md
@@ -2,34 +2,26 @@
 
 
 
-<div align="center">
-  <a href="https://raycast.com">
-    <img src="./images/logo.png" height="250px">
-  </a>
 
-  <br/>
-  <br/>
-  <h1>Raycast Script Commands</h1>
+
+
+
 
 ![Header](images/screenshots/readme-header.png)
-<a href="https://github.com/raycast/script-commands">
 
-  <img alt="GitHub contributors" src="https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=red&label=Script%20Commands&query=$.totalScriptCommands&url=https:%2F%2Fraw.githubusercontent.com%2Fraycast%2Fscript-commands%2Fmaster%2Fcommands%2Fextensions.json&logo=data:image%2Fpng%3Bbase64,iVBORw0KGgoAAAANSUhEUgAAAFgAAABYCAIAAAD%2B96djAAAIC0lEQVR4nOybW2zb1hmADynqLsuWRFLOBVmTpqkVy5LlpkgfDGRdnSvcdSiKIUWHosO8lwDtw4Bge1pRYMAw9KXAgAxYMiTNGjRZt%2B5plxQIkCzpNjduZMmJnMRpt7WR7NgSJYqULFISNUQ8pikpKVLpkOwDP%2BQhUajj40%2F%2Ff3j%2Bn0fEY1sfByYA4EZP4JuCKQJiioCYIiCmCIgpAmKKgJgiIKYIiCkCYoqAmCIgpgiIKQJiioCYIiDGi9jidIQ8bqNnYbSIkNv9h7HY%2B7HRXf39xs7ESBFbnc5To5Gg3d5vtf4uMhLu8xg4GSNF7BroJ202%2Be9eK3EmNvr0gGFxYRnw%2BY362SmeL1Rrzwb8AMMAAHYc30%2BSl3JMtlrVfzJGigAAJDguXRH2kQHowmJ5Phi8kmeWRVHnmegt4gmXa7vLlRYE5ZUUz%2BertT0BPwZd4JNBejpfWFJdowO6itjssJ8bix3euGGGZdOV9d8zwXFtOXKQoi4yuayoX47oJ2Kzw%2FHuaHSz00ng%2BH6K%2BpjJ31PFf4Lj%2BHp93O9T4mKCJC8zTE6v9UI%2FEc8M9B%2FeuNGy9plPBulrrXERLxbvVip7SVJ24SGIFwaDuuWIfiI%2BK68u8KVDNIUpLmi6LUfm%2BVJnjuizduq6RnxWLmcqwgQZkF0QOH6Aoq51rBeda%2BelnObrhbYiQm73bt%2FAQqmsvJLi%2BYVSaS9Fyjlia8bFbLH4ZaWiXJPgOLWvtdgpZrTMEQ1FbHU634tFX9wwmCxy%2F11dBQAMEMSugX6x0ahJjRFvn3wZgeOHaGpREAI22xanU%2F7D1%2Bsei2W7GxZjDovlgMY5gml0LCDkcZ%2BKRmi7HQAgStKRuRsXcrlxv%2B%2F3o9GuxyzWalPJuasFFulMIVrVGttcrsBaHWHD8Z9sewzreUwvQZwYCYfcmtTsWon4y%2FLKVGJOlCQAwE2OfyWeaKAY1mu1nh2LaVGnalh9XmSYI3M3Uhz3cny2UKuhGlauU2NeL6oBZVCK2Oyw7yNJ9SsXcrnJq58itCDjJYhT0cgQ0r4WMhHyDvrX4Z37qRYXSDJCZjpfkBpwPK%2BVOBmN7HC7UA2ORsQTLtefnoptc7lsOH4sPPzShkEkw7ZxbnHx6PxNxcWg3f7BU2OocgSNCJ%2FV6iUIOCKG%2FWroyYOtcYGKD5fuvXX7DlDiopkjSNZONCI%2BYdnXEklubS3AMeyd4Z0auTidTr95%2B446R87ERnvvgyNbI6YL7A%2FiCcWFDcdf3rQR1eBtnE6nfzp%2FS1LFRe998O5FbHU6v9%2B6FiQ57sfJuUq93suEHpE%2FLi39YmE9R3rvg3cpIuRxnx0b%2FeXQk69u2qR%2BfbpwP0d41PdLGWUZkjl59wE50nUfvJuia4vDcSY2GrTbMQx7NuBPV4QUzyv%2Fm64I11h2kqYzgvDnpXstb3Q6Xxzs%2FobyzMBAosh90VqnouqDdxMRbovFga%2B9EcPeDj0gLqY0yBGHxXI8Et7d%2BpmfTqePzt9ScsSK457WwHlEuomIbLU6w7IHaMou68CwPQF%2FoVpLcJxyzZeVyr8LbLnVRY8R8bBejtIHFyTp9RupK%2Fl8FyN32Y%2FICMIVhpmkabsFb6q4nyN8vR4vFpVryh0R0bsIpZfT2QdnxOq76fQ%2FmG4s9NSYWRbFT1l2P0XaLRbQlDHu992tVOb50sPegkSEHBedffAkx6nbXF%2BXnvYRV1n2cHy2qNpHvR0aalsvEPL35RW5rgcA9BHEe7HobnTPSnvdUM3zpVfis8Xquou3dmzXyMVH2ewb11PK%2FbKvub9G5QLBzvI6x7%2BWSCpxATDszR3bX0KRAp2cz2bVe0r5lolkZGQ9yyGP%2B2Q0MthsUgIApEbj57cWzmQy6msom23c7%2Bv6R8wUWHkVOEiR7wzvXK3Xp5JzM2yx57kDxM3bHW7XB2NjXiu8jV9mmFdnk6gGb%2BMQRS2LAioLiDtUt0vllhxBhBXDjkfCzwUC6hf%2FurKC0AL6nmW8WFSvnb1jxbDfjAxPkOSxkeHvBDR8FoW%2BeXud4w9fi7OInmIfCw8%2F1%2ByD2nD8t5GR7wVpJMN2okkXe75UmkrOIcmRs5lFZe9QlSROsxpfqyddAADaZjvyrS191vUS6JM8e25xUX2NlyB%2B9vg2eZ8uc345%2B1E2q77m237%2FiehIVZJ%2BlJz7Z76g0Ww1FAEAeLq%2F%2F0Qk7LVa5X9KjcbR%2BZsfttbm4z7f8UjYIe%2FTm88H37iROr%2FS4uK7QbpUq1%2FI5bSbqrZPwzOCcIlhng8G5W0PhmF7SbKtTv2iUrlfy1KUrXmNBcMO0VRGaOlx3CqV%2FtN8jKwdmp%2BPyIrVzjo13%2BpC6eUQa74myMBCqXSnXNZ0bmr0OCiyLIrThcLB1v5FpqOvNXO%2FlqXWY4ciPy%2BX1WcrNEWnEzNLgnAxl5sgSbl9JH%2FmXK02W2yJi4%2BZ%2FGSQll3wtdr7mYymh0PU6Hd0KCtWLzPMC8GgkiN7%2FO05ck8U5RypNRo%2FTCTR7h2%2FGl3PUOWq1c4cKXSsFzMs%2B7eVlX9pcyDkYeh98nbpQT2%2Bzj74%2F1a77zV1hwFnsZdF8VIuNxmkHWs9vn1koC1H9MeYQ%2BkP7IMzYjVpnAvDvq8xw7bUqaIkfb6q366hEyO%2FpqD0wSUAXr%2Be6roTjwRta41HIeRxewhCo0ODj043T8fQ8hXPQfTE%2BK87fkMwRUBMERBTBMQUATFFQEwREFMExBQBMUVATBEQUwTEFAExRUBMERBTBOT%2FAQAA%2F%2F98wKt7wQJ9rAAAAABJRU5ErkJggg%3D%3D&labelColor=202123" height="30" width="auto" style="border-radius: 1em">
-  </a>
-  <a href="https://github.com/raycast/script-commands/graphs/contributors">
-    <img alt="GitHub contributors" src="https://img.shields.io/github/stars/raycast?style=for-the-badge" height="30" width="auto" style="border-radius: 1em">
-  </a>
-  <a href="https://github.com/raycast/script-commands/stargazers">
-    <img alt="GitHub Org's stars" src="https://img.shields.io/github/contributors/raycast/script-commands?style=for-the-badge"height="30" width="auto" style="border-radius:1em">
+<a href="https://github.com/raycast/script-commands">
+  <img alt="GitHub contributors" src="https://img.shields.io/badge/dynamic/json??style=flat&color=red&label=Script%20Commands&query=$.totalScriptCommands&url=https:%2F%2Fraw.githubusercontent.com%2Fraycast%2Fscript-commands%2Fmaster%2Fcommands%2Fextensions.json&logo=data:image%2Fpng%3Bbase64,iVBORw0KGgoAAAANSUhEUgAAAFgAAABYCAIAAAD%2B96djAAAIC0lEQVR4nOybW2zb1hmADynqLsuWRFLOBVmTpqkVy5LlpkgfDGRdnSvcdSiKIUWHosO8lwDtw4Bge1pRYMAw9KXAgAxYMiTNGjRZt%2B5plxQIkCzpNjduZMmJnMRpt7WR7NgSJYqULFISNUQ8pikpKVLpkOwDP%2BQhUajj40%2F%2Ff3j%2Bn0fEY1sfByYA4EZP4JuCKQJiioCYIiCmCIgpAmKKgJgiIKYIiCkCYoqAmCIgpgiIKQJiioCYIiDGi9jidIQ8bqNnYbSIkNv9h7HY%2B7HRXf39xs7ESBFbnc5To5Gg3d5vtf4uMhLu8xg4GSNF7BroJ202%2Be9eK3EmNvr0gGFxYRnw%2BY362SmeL1Rrzwb8AMMAAHYc30%2BSl3JMtlrVfzJGigAAJDguXRH2kQHowmJ5Phi8kmeWRVHnmegt4gmXa7vLlRYE5ZUUz%2BertT0BPwZd4JNBejpfWFJdowO6itjssJ8bix3euGGGZdOV9d8zwXFtOXKQoi4yuayoX47oJ2Kzw%2FHuaHSz00ng%2BH6K%2BpjJ31PFf4Lj%2BHp93O9T4mKCJC8zTE6v9UI%2FEc8M9B%2FeuNGy9plPBulrrXERLxbvVip7SVJ24SGIFwaDuuWIfiI%2BK68u8KVDNIUpLmi6LUfm%2BVJnjuizduq6RnxWLmcqwgQZkF0QOH6Aoq51rBeda%2BelnObrhbYiQm73bt%2FAQqmsvJLi%2BYVSaS9Fyjlia8bFbLH4ZaWiXJPgOLWvtdgpZrTMEQ1FbHU634tFX9wwmCxy%2F11dBQAMEMSugX6x0ahJjRFvn3wZgeOHaGpREAI22xanU%2F7D1%2Bsei2W7GxZjDovlgMY5gml0LCDkcZ%2BKRmi7HQAgStKRuRsXcrlxv%2B%2F3o9GuxyzWalPJuasFFulMIVrVGttcrsBaHWHD8Z9sewzreUwvQZwYCYfcmtTsWon4y%2FLKVGJOlCQAwE2OfyWeaKAY1mu1nh2LaVGnalh9XmSYI3M3Uhz3cny2UKuhGlauU2NeL6oBZVCK2Oyw7yNJ9SsXcrnJq58itCDjJYhT0cgQ0r4WMhHyDvrX4Z37qRYXSDJCZjpfkBpwPK%2BVOBmN7HC7UA2ORsQTLtefnoptc7lsOH4sPPzShkEkw7ZxbnHx6PxNxcWg3f7BU2OocgSNCJ%2FV6iUIOCKG%2FWroyYOtcYGKD5fuvXX7DlDiopkjSNZONCI%2BYdnXEklubS3AMeyd4Z0auTidTr95%2B446R87ERnvvgyNbI6YL7A%2FiCcWFDcdf3rQR1eBtnE6nfzp%2FS1LFRe998O5FbHU6v9%2B6FiQ57sfJuUq93suEHpE%2FLi39YmE9R3rvg3cpIuRxnx0b%2FeXQk69u2qR%2BfbpwP0d41PdLGWUZkjl59wE50nUfvJuia4vDcSY2GrTbMQx7NuBPV4QUzyv%2Fm64I11h2kqYzgvDnpXstb3Q6Xxzs%2FobyzMBAosh90VqnouqDdxMRbovFga%2B9EcPeDj0gLqY0yBGHxXI8Et7d%2BpmfTqePzt9ScsSK457WwHlEuomIbLU6w7IHaMou68CwPQF%2FoVpLcJxyzZeVyr8LbLnVRY8R8bBejtIHFyTp9RupK%2Fl8FyN32Y%2FICMIVhpmkabsFb6q4nyN8vR4vFpVryh0R0bsIpZfT2QdnxOq76fQ%2FmG4s9NSYWRbFT1l2P0XaLRbQlDHu992tVOb50sPegkSEHBedffAkx6nbXF%2BXnvYRV1n2cHy2qNpHvR0aalsvEPL35RW5rgcA9BHEe7HobnTPSnvdUM3zpVfis8Xquou3dmzXyMVH2ewb11PK%2FbKvub9G5QLBzvI6x7%2BWSCpxATDszR3bX0KRAp2cz2bVe0r5lolkZGQ9yyGP%2B2Q0MthsUgIApEbj57cWzmQy6msom23c7%2Bv6R8wUWHkVOEiR7wzvXK3Xp5JzM2yx57kDxM3bHW7XB2NjXiu8jV9mmFdnk6gGb%2BMQRS2LAioLiDtUt0vllhxBhBXDjkfCzwUC6hf%2FurKC0AL6nmW8WFSvnb1jxbDfjAxPkOSxkeHvBDR8FoW%2BeXud4w9fi7OInmIfCw8%2F1%2ByD2nD8t5GR7wVpJMN2okkXe75UmkrOIcmRs5lFZe9QlSROsxpfqyddAADaZjvyrS191vUS6JM8e25xUX2NlyB%2B9vg2eZ8uc345%2B1E2q77m237%2FiehIVZJ%2BlJz7Z76g0Ww1FAEAeLq%2F%2F0Qk7LVa5X9KjcbR%2BZsfttbm4z7f8UjYIe%2FTm88H37iROr%2FS4uK7QbpUq1%2FI5bSbqrZPwzOCcIlhng8G5W0PhmF7SbKtTv2iUrlfy1KUrXmNBcMO0VRGaOlx3CqV%2FtN8jKwdmp%2BPyIrVzjo13%2BpC6eUQa74myMBCqXSnXNZ0bmr0OCiyLIrThcLB1v5FpqOvNXO%2FlqXWY4ciPy%2BX1WcrNEWnEzNLgnAxl5sgSbl9JH%2FmXK02W2yJi4%2BZ%2FGSQll3wtdr7mYymh0PU6Hd0KCtWLzPMC8GgkiN7%2FO05ck8U5RypNRo%2FTCTR7h2%2FGl3PUOWq1c4cKXSsFzMs%2B7eVlX9pcyDkYeh98nbpQT2%2Bzj74%2F1a77zV1hwFnsZdF8VIuNxmkHWs9vn1koC1H9MeYQ%2BkP7IMzYjVpnAvDvq8xw7bUqaIkfb6q366hEyO%2FpqD0wSUAXr%2Be6roTjwRta41HIeRxewhCo0ODj043T8fQ8hXPQfTE%2BK87fkMwRUBMERBTBMQUATFFQEwREFMExBQBMUVATBEQUwTEFAExRUBMERBTBOT%2FAQAA%2F%2F98wKt7wQJ9rAAAAABJRU5ErkJggg%3D%3D&labelColor=202123" height="30" width="auto">
   </a>
+
+
   <a href="https://twitter.com/raycastapp">
-    <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/raycastapp?style=for-the-badge"height="30" width="auto" style="border-radius:1em ">
+    <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/raycastapp?style=flat&color=blue"height="30" width="auto">
   </a>
 </div>
   <hr>
   <br/>
   <br/>
-</div>
+
 
 [Raycast](https://raycast.com/) lets you control your tools with a few keystrokes and installing script commands makes it possible to execute commands from anywhere on your desktop. They are a great way to speed up every-day tasks such as converting data, opening bookmarks or triggering dev workflows.
 
@@ -101,7 +93,7 @@ else
 
 ## Troubleshooting and FAQs
 <details>
-  <summary>My script isn't appearing in Raycast!</summary>
+  <summary>Why isn't my script appearing in Raycast?</summary>
 
 
 * Ensure the filename doesn't contain `.template.` string