Skip to content

Commit 9b13882

Browse files
0xNineteen0xNineteen
committed
2 parents 2b0bc6a + 501f131 commit 9b13882

File tree

4 files changed

+164
-19
lines changed

4 files changed

+164
-19
lines changed

‎.all-contributorsrc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"files": [
3+
"README.md"
4+
],
5+
"imageSize": 100,
6+
"commit": false,
7+
"commitConvention": "angular",
8+
"contributors": [
9+
{
10+
"login": "0xNineteen",
11+
"name": "x19",
12+
"avatar_url": "https://avatars.githubusercontent.com/u/100000306?v=4",
13+
"profile": "https://github.com/0xNineteen",
14+
"contributions": [
15+
"code"
16+
]
17+
}
18+
],
19+
"contributorsPerLine": 7,
20+
"skipCi": true,
21+
"repoType": "github",
22+
"repoHost": "https://github.com",
23+
"projectName": "half-baked-client",
24+
"projectOwner": "tinydancer-io"
25+
}

‎CONTRIBUTING.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11+
build.
12+
2. Update the README.md with details of changes to the interface, this includes new environment
13+
variables, exposed ports, useful file locations and container parameters.
14+
3. Increase the version numbers in any examples files and the README.md to the new version that this
15+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
16+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17+
do not have permission to do that, you may request the second reviewer to merge it for you.
18+
19+
## Code of Conduct
20+
21+
### Our Pledge
22+
23+
In the interest of fostering an open and welcoming environment, we as
24+
contributors and maintainers pledge to making participation in our project and
25+
our community a harassment-free experience for everyone, regardless of age, body
26+
size, disability, ethnicity, gender identity and expression, level of experience,
27+
nationality, personal appearance, race, religion, or sexual identity and
28+
orientation.
29+
30+
### Our Standards
31+
32+
Examples of behavior that contributes to creating a positive environment
33+
include:
34+
35+
* Using welcoming and inclusive language
36+
* Being respectful of differing viewpoints and experiences
37+
* Gracefully accepting constructive criticism
38+
* Focusing on what is best for the community
39+
* Showing empathy towards other community members
40+
41+
Examples of unacceptable behavior by participants include:
42+
43+
* The use of sexualized language or imagery and unwelcome sexual attention or
44+
advances
45+
* Trolling, insulting/derogatory comments, and personal or political attacks
46+
* Public or private harassment
47+
* Publishing others' private information, such as a physical or electronic
48+
address, without explicit permission
49+
* Other conduct which could reasonably be considered inappropriate in a
50+
professional setting
51+
52+
### Our Responsibilities
53+
54+
Project maintainers are responsible for clarifying the standards of acceptable
55+
behavior and are expected to take appropriate and fair corrective action in
56+
response to any instances of unacceptable behavior.
57+
58+
Project maintainers have the right and responsibility to remove, edit, or
59+
reject comments, commits, code, wiki edits, issues, and other contributions
60+
that are not aligned to this Code of Conduct, or to ban temporarily or
61+
permanently any contributor for other behaviors that they deem inappropriate,
62+
threatening, offensive, or harmful.
63+
64+
### Scope
65+
66+
This Code of Conduct applies both within project spaces and in public spaces
67+
when an individual is representing the project or its community. Examples of
68+
representing a project or community include using an official project e-mail
69+
address, posting via an official social media account, or acting as an appointed
70+
representative at an online or offline event. Representation of a project may be
71+
further defined and clarified by project maintainers.
72+
73+
### Enforcement
74+
75+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
76+
reported by contacting the project team at [email protected]. All
77+
complaints will be reviewed and investigated and will result in a response that
78+
is deemed necessary and appropriate to the circumstances. The project team is
79+
obligated to maintain confidentiality with regard to the reporter of an incident.
80+
Further details of specific enforcement policies may be posted separately.
81+
82+
Project maintainers who do not follow or enforce the Code of Conduct in good
83+
faith may face temporary or permanent repercussions as determined by other
84+
members of the project's leadership.
85+
86+
### Attribution
87+
88+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
89+
available at [http://contributor-covenant.org/version/1/4][version]
90+
91+
[homepage]: http://contributor-covenant.org
92+
[version]: http://contributor-covenant.org/version/1/4/

‎README.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Tinydancer (V0)
2+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3+
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
4+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
5+
6+
## Architecture
7+
The client is designed to be modular and easily extensible for additional functionality as this is the v0 and with every major version there may be a need for major changes and add-on services.
8+
9+
### Bird's Eye View
10+
11+
![Architecture Diagram](https://res.cloudinary.com/dev-connect/image/upload/v1675235495/diet-client-v0-arch_bhdd4c.png)
12+
13+
## Getting started
14+
15+
Build and add to path
16+
```
17+
cargo b -r && cp ./target/release/tinydancer ~/.local/bin/
18+
```
19+
Or install using cargo
20+
```
21+
cargo install --git https://github.com/tinydancer-io/half-baked-client tinydancer
22+
```
23+
24+
## Contributors
25+
26+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
27+
<!-- prettier-ignore-start -->
28+
<!-- markdownlint-disable -->
29+
<table>
30+
<tbody>
31+
<tr>
32+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/0xNineteen"><img src="https://avatars.githubusercontent.com/u/100000306?v=4?s=100" width="100px;" alt="x19"/><br /><sub><b>x19</b></sub></a><br /><a href="https://github.com/tinydancer-io/half-baked-client/commits?author=0xNineteen" title="Code">💻</a></td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
37+
<!-- markdownlint-restore -->
38+
<!-- prettier-ignore-end -->
39+
40+
<!-- ALL-CONTRIBUTORS-LIST:END -->
41+
<!-- prettier-ignore-start -->
42+
<!-- markdownlint-disable -->
43+
44+
<!-- markdownlint-restore -->
45+
<!-- prettier-ignore-end -->
46+
47+
<!-- ALL-CONTRIBUTORS-LIST:END -->

‎readme.md‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)