Skip to content

Commit 03c03c6

Browse files
author
github username
committed
Updated the recipe contribution guide
1 parent 7f49f80 commit 03c03c6

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Diff for: cli/recipes.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Amber generators can use a recipe to generate your application, and scaffold you
66

77
### Recipe contributors
88

9-
Recipes are provided by independent contributors in their own github accounts. To use a recipe you specify the github account name and recipe name in the format _githubaccount/recipe_name_.
10-
Recipe creators should add the **amber-recipe** topic to the github repository for the recipe.
9+
Recipes are provided by independent contributors in their own GitHub accounts. To use a recipe you specify the GitHub account name and recipe name in the format _githubaccount/recipe_name_.
10+
Recipe creators should add the **amber-recipe** topic to the GitHub repository for the recipe.
1111

1212
### Available recipes
1313

14-
See the [Amber Recipes](https://github.com/topics/amber-recipe) that are available on github for a list
14+
See the [Amber Recipes](https://github.com/topics/amber-recipe) that are available on GitHub for a list
1515
of recipes that have been created by recipe contributors. Visit the recipe repository for more information about each recipe.
1616

1717
### Amber New Command with a recipe
@@ -44,7 +44,7 @@ Options:
4444

4545
### Example Usage
4646

47-
Using `amber new microsecond-blog -r damianham/amber_modular` will generate a skeleton Amber application in `./microsecond-blog` using the _amber_modular_ recipe that was provided by the github user _damianham_.
47+
Using `amber new microsecond-blog -r damianham/amber_modular` will generate a skeleton Amber application in `./microsecond-blog` using the _amber_modular_ recipe that was provided by the GitHub user _damianham_.
4848

4949
You can have a running web application in a matter of minutes:
5050

@@ -98,7 +98,7 @@ Once an application is generated with a recipe, it will be used by future genera
9898
### Custom Recipe
9999

100100
When a recipe doesn't quite suite your requirements, it's easy to modify. Recipes are application stubs written in [Liquid](https://github.com/TechMagister/liquid.cr).
101-
Modified recipes can be stored and sourced locally or made available to other Amber users from your own github account.
101+
Modified recipes can be stored and sourced locally or made available to other Amber users from your own GitHub account.
102102

103103
Download a recipe that you want to modify, extract it, and use the extracted recipe on the command line. For example:
104104

@@ -115,10 +115,10 @@ It is important to give the absolute path to the recipe folder as the recipe com
115115

116116
### Contributing your recipe
117117

118-
The best way to do this is to fork an existing recipe and then modify it. Visit the github repository of a recipe you want to use as a starting point, e.g. one of the recipes listed above in the **Available recipes** section, and create your own fork. After you have modified the recipe and pushed your changes you can create apps with your recipe with:
118+
The best way to do this is to fork an existing recipe and then modify it. Visit the GitHub repository of a recipe you want to use as a starting point, e.g. one of the recipes listed above in the **Available recipes** section, and create your own fork. After you have modified the recipe and pushed your changes you can create apps with your recipe with:
119119

120120
```
121121
amber new myapp -r your_github_name/your_recipe_name
122122
```
123123

124-
You can easily contribute your recipe to the Amber community. Create a fork of [amber-docs](https://github.com/amberframework/docs), edit this page to add your recipe to the **Available recipes** section and submit a Pull Request.
124+
You can easily contribute your recipe to the Amber community. By adding the **amber-recipe** topic to your recipe repository on GitHub, it will be added to the list of [Amber Recipes](https://github.com/topics/amber-recipe).

0 commit comments

Comments
 (0)