Skip to content

Commit 04a0868

Browse files
committed
docs updates
1 parent 5eea69b commit 04a0868

File tree

5 files changed

+488
-49
lines changed

5 files changed

+488
-49
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Changelog
22

3+
4+
## 1.2.1 - 2024-10-06
5+
- small fixes, more docs
6+
7+
## 1.2.0 - 2024-10-01
8+
- update all new methods
9+
310
## 1.0.0 - 2024-06-06
411

512
- Initial release of the SharpAPI Node.js SDK Client.

CONTRIBUTION.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## Contributing
2+
3+
We welcome contributions to the SharpAPI Node.js SDK Client! If you'd like to contribute, please follow these steps:
4+
5+
1. **Fork the Repository**
6+
7+
Click the "Fork" button at the top-right corner of the repository page to create your own fork.
8+
9+
2. **Clone the Forked Repository**
10+
11+
```bash
12+
git clone https://github.com/yourusername/sharpapi-node-client.git
13+
```
14+
15+
3. **Navigate to the Project Directory**
16+
17+
```bash
18+
cd sharpapi-node-client
19+
```
20+
21+
4. **Create a New Branch**
22+
23+
```bash
24+
git checkout -b feature/your-feature-name
25+
```
26+
27+
5. **Make Your Changes**
28+
29+
Implement your feature or bug fix.
30+
31+
6. **Commit Your Changes**
32+
33+
```bash
34+
git add .
35+
git commit -m "Add feature: Your Feature Name"
36+
```
37+
38+
7. **Push to Your Fork**
39+
40+
```bash
41+
git push origin feature/your-feature-name
42+
```
43+
44+
8. **Create a Pull Request**
45+
46+
Go to the original repository on GitHub and create a pull request from your forked repository.
47+
48+
### Guidelines
49+
50+
- **Follow Coding Standards:** Ensure your code adheres to the existing coding style.
51+
- **Write Tests:** Add tests for your new features or bug fixes.
52+
- **Update Documentation:** If your changes affect the usage, update the `DOCUMENTATION.md` accordingly.
53+
- **Provide Clear Descriptions:** Make sure your commit messages and pull request descriptions are clear and concise.

LICENCE.md renamed to LICENSE.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
MIT License
22

3-
Copyright (c) 2024 SharpAPI
4-
53
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
64

75
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

0 commit comments

Comments
 (0)