Skip to content

Commit

Permalink
Update readme and banner (#7)
Browse files Browse the repository at this point in the history
* Add alt text, interaction reminder, to readme

* Update hero banner with current options
  • Loading branch information
thinknathan authored Feb 25, 2024
1 parent 647215d commit 80292b5
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"editor.codeActionsOnSave": {
"source.formatDocument": true,
"source.fixAll.eslint": true
"source.formatDocument": "explicit",
"source.fixAll.eslint": "explicit"
},
"eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"],
"typescript.tsdk": "node_modules/typescript/lib",
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<a href="https://discord.gg/eukcq5m"><img alt="Chat with us!" src="https://img.shields.io/discord/766898804896038942.svg?colorB=7581dc&logo=discord&logoColor=white"></a>

<p align="center">
<img src="docs/hero.png">
<img src="docs/hero.png" alt="Command-line interface showing options --template, --version and --help">
</p>

```sh
Expand All @@ -14,6 +14,9 @@
```

## Templates
By default the CLI will search for templates on [github](https://github.com/search?q=tsd-template&type=repositories) that follow the pattern `tsd-template-*`. i.e. `--template war-battles` resolves to [tsd-template-war-battles](https://github.com/ts-defold/tsd-template-war-battles).
By default the CLI will search for templates on [Github](https://github.com/search?q=tsd-template&type=repositories) that follow the pattern `tsd-template-*`. i.e. `--template war-battles` resolves to [tsd-template-war-battles](https://github.com/ts-defold/tsd-template-war-battles).

As an alternative, you may also supply a zip archive either from a local path or remote url to seed the project with.

## Give Kudos
:star: If the ts-defold project is useful, inspiring, or fun for you, please give this [Github repo](https://github.com/ts-defold/create) a star. :star:
Binary file modified docs/hero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 80292b5

Please sign in to comment.