Skip to content

Commit 7efb147

Browse files
author
ThinLiquid
authored
Merge pull request #1 from NonGMOTrash/NonGMOTrash-rewording
reworded some things in index.html for clarity
2 parents 9b2e670 + df6d7d9 commit 7efb147

1 file changed

Lines changed: 11 additions & 12 deletions

File tree

src/index.html

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h1>deploy2nekoweb</h1>
2424
<hr />
2525
<p>
2626
<b>deploy2nekoweb</b> is a GitHub Action that efficiently deploys your
27-
website(s) to <a href="https://nekoweb.org/">nekoweb</a> with ease.
27+
website(s) to <a href="https://nekoweb.org/">nekoweb</a> with ease whenever you make a commit.
2828
</p>
2929
<p>
3030
using the power of <a href="https://bun.sh">bun</a>, it's never been more faster to deploy a
@@ -56,10 +56,18 @@ <h2>usage</h2>
5656
uses: indiefellas/deploy2nekoweb@main
5757
with:
5858
nekoweb-api-key: ${{ secrets.NEKOWEB_API_KEY }}
59-
nekoweb-domain: 'deploy.nekoweb.org'
60-
nekoweb-username: 'deploy'
59+
nekoweb-domain: 'yoursite.nekoweb.org'
60+
nekoweb-username: 'yourname'
6161
directory: 'public'</code></pre>
6262

63+
<h3>config</h3>
64+
<p>
65+
<code>nekoweb-api-key</code> - the API key for your nekoweb account <small>(get it from <a href="https://nekoweb.org/api">here</a>)</small><br/>
66+
<code>nekoweb-domain</code> - the nekoweb site you will deploy to <small>(if you have a custom domain like <code>my-awesome-site.com</code>, use that here)</small><br/>
67+
<code>nekoweb-username</code> - your nekoweb username<br/>
68+
<code>directory</code> - the directory in your repository that will be deployed to nekoweb<br/>
69+
</p>
70+
6371
<h3 class="orange">important information!</h3>
6472
<p>
6573
when using this action, make sure to use the <a href="#repo-secret">Secrets and variables</a> feature in GitHub
@@ -76,15 +84,6 @@ <h4 id="repo-secret">how to make a repository secret</h4>
7684
<li>profit.</li>
7785
</ol>
7886

79-
<h3>config</h3>
80-
<p>
81-
<code>nekoweb-api-key</code>* - the API key for your nekoweb account<br/>
82-
<code>nekoweb-domain</code>* - the nekoweb domain you will deploy to<br/>
83-
<code>nekoweb-username</code>* - your nekoweb username<br/>
84-
<code>directory</code>* - the directory to deploy to nekoweb<br/>
85-
</p>
86-
<p>* required</p>
87-
8887
<script type="module">
8988
import { codeToHtml } from 'https://esm.sh/shiki@1.0.0'
9089
import dedent from 'https://esm.sh/dedent'

0 commit comments

Comments
 (0)