Skip to content

Commit

Permalink
simplified the README, and TEMPLATE
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan Tarbert authored and Nathan Tarbert committed Sep 30, 2024
1 parent fdc1c96 commit e24dfb2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion demos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

1. **Project Setup and Guidelines**: Refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file for detailed setup instructions and guidelines.
2. **Choose a Topic**: Visit our [Issues section](https://github.com/CopilotKit/CopilotKit/issues) tagged with `hacktoberfest`. CopilotKit will allow multi-assign!
3. **Submit Your Demo**: Create and submit your project as per the instructions in `CONTRIBUTING.md`.
3. **Submit Your Demo**: Create and submit your project according to the steps listed in the `CONTRIBUTING.md`.
4. **Add Your Name**: Don't forget to add your name to the `List.md` to be part of our contributors' list!

## Why Join?
Expand Down
6 changes: 4 additions & 2 deletions demos/TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,21 @@ Briefly explain the purpose of your demo and the value it provides.

List the technologies and frameworks you are using (e.g., Next.js, Python, Laravel, NestJS). This helps us attract the right people to test your project.

### Note: Please only use the [shadcn component library](https://ui.shadcn.com/) for consistancy.

- Technology 1
- Technology 2
- Technology 3

## App Link

If your app is live, include the link here:
[Live Demo](http://your-app-link.com)
[Live Demo](http://google.com)

## Screenshot

Include a screenshot of your demo in action:
![Screenshot](path/to/screenshot.png)
![Screenshot]()

## Detailed Description

Expand Down

0 comments on commit e24dfb2

Please sign in to comment.