-
Notifications
You must be signed in to change notification settings - Fork 105
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Hello, World! function #1
Conversation
hello-world/README.md
Outdated
@@ -0,0 +1,13 @@ | |||
# Hello World Function |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would love to give READMes structure. Ideally it should have all information developer would need to install it, configure it, and use it.
Here is my proposal, let me know what you think:
- Title
- Short description
- Installation Instructions
- runtime (mention which it was tried on, mention others might or night not work)
- env variables (name, isRequired, description, example value. If relevant, link to external docs)
- entrypoint
- build commands
- recommended events (only if not empty)
- recommended corn (only if not empty)
- recommended timeout (only if not empty)
- recommended permissions (only if not empty)
- How to use (like long description. document all possibilities - endpoints.. expected behaviour.. Like tests, but just written down)
Ideally we would have template README somewhere, so when we make new template, we use that as the base
Co-authored-by: Matej Bačo <[email protected]>
Co-authored-by: Matej Bačo <[email protected]>
Co-authored-by: Matej Bačo <[email protected]>
closing in favour of starter template |
Github issue bot files added
What does this PR do?
Adds a basic Hello, World! function
Test Plan
You can run the function locally by creating the neccessary .env and executing
npx appwrite-function-utils dev src/main.js
armang4.appwrite.org link:
Have you read the Contributing Guidelines on issues?
Yes