Skip to content
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

chore: add initial readme and license info #4

Merged
merged 10 commits into from
Mar 31, 2023
Merged

Conversation

drochetti
Copy link
Collaborator

No description provided.

README.md Outdated
2. Get your function id and run it:

```ts
const result = await fal.run("my-function-alias");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

id instead of alias?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good call! changed

README.md Outdated
Comment on lines 53 to 59
1. Make sure you read our [Code of Conduct](https://github.com/fal-ai/serverless-js/blob/main/CODE_OF_CONDUCT.md)
1. Fork the project and clone your fork
1. Setup the local environment with `npm install`
1. Create a feature branch (`git checkout -b feature/add-cool-thing`) or a bugfix branch (`git checkout -b fix/smash-that-bug`)
1. Commit the changes (`git commit -m 'Some meaningful message'`)
1. Push to the branch (`git push --set-upstream origin feature/add-cool-thing`)
1. Open a Pull Request
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all of them are 1., intentional?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it was, Markdown renders it correctly, which makes it easier to edit without worrying about the numbers being correct. But honestly, it can be confusing, so I changed it =)

@drochetti drochetti merged commit 1724bc3 into main Mar 31, 2023
@drochetti drochetti deleted the chore/documentation branch March 31, 2023 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants