diff options
Diffstat (limited to 'examples/README.md')
| -rw-r--r-- | examples/README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 000000000..557736ab2 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,22 @@ +# Astro Examples Library + + +The easiest way to check out one of these examples on your machine is by running this command in an empty directory: + +``` +npm init astro --template [EXAMPLE_NAME] +``` + +## Community Examples + +Visit [awesome-astro](https://github.com/one-aalam/awesome-astro) for a full list of community examples. You can use `npm init astro` to check out any community examples: + +``` +npm init astro --template [GITHUB_USER]/[REPO_NAME] +``` + +Paths to examples nested inside of a repo are also supported: + +``` +npm init astro --template [GITHUB_USER]/[REPO_NAME]/path/to/example +``` |