Skip to content

Commit

Permalink
Merge pull request #11 from raizo07/feat/generateChangelog
Browse files Browse the repository at this point in the history
Feat/generate changelog
  • Loading branch information
akiraonstarknet authored May 1, 2024
2 parents 7c1b4ba + 479be0c commit 4cb5da4
Show file tree
Hide file tree
Showing 4 changed files with 8,032 additions and 7 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,13 @@ The project is build using NextJS and Typescript. Below is the broad project str

[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/strkfarm/starkfarm-client/issues)
Requirements:
1. Node 18+
1. Node 20+

Clone the repository
```bash
git clone https://github.com/strkfarm/starkfarm-client.git
```


Install dependencies and run the development build

```bash
Expand All @@ -59,18 +58,21 @@ You should see something like this:

## 🤝 Contribute


We're always looking for for stallions with great NextJS & Typescript skills to further this tool, to join our community and contribute to STRKFarm. Check out our [contributing guide](./CONTRIBUTING.md)
for more information on how to get started.

To connect with us regarding any queries about contributing to the repo, feel free to join our telegram group [here](https://t.me/+HQ_eHaXmF-1lZDc1). Head to `dev` topic.


## References

- [Telegram](https://t.me/+HQ_eHaXmF-1lZDc1)
- [OnlyDust](https://app.onlydust.com/p/strkfarm)
- [Website](https://www.strkfarm.xyz/)

## Contributors
## Contributors ✨
Thanks goes to these wonderful people.

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
Expand All @@ -81,5 +83,5 @@ To connect with us regarding any queries about contributing to the repo, feel fr

<!-- ALL-CONTRIBUTORS-LIST:END -->

[![All Contributors](https://img.shields.io/github/all-contributors/akiraonstarknet/starkfarm-client?color=ee8449&style=flat-square)](#contributors)

[![All Contributors](https://img.shields.io/github/all-contributors/akiraonstarknet/starkfarm-client?color=ee8449&style=flat-square)](#contributors)
22 changes: 22 additions & 0 deletions generateChangelog.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
const fs = require("fs");
const { version } = require("./package.json");

// write changelog to CHANGELOG.md
fs.writeFileSync("CHANGELOG.md", changelogContent);

// Update current version in README
fs.readFile("README.md", "utf8", (err, data) => {
if (err) {
console.error(err);
return;
}

const updatedReadme = data.replace(/CURRENT_VERSION_PLACEHOLDER/g, version);
fs.writeFile("README.md", updatedReadme, "utf8", (err) => {
if (err) {
console.error(err);
return;
}
console.log("README updated with current version");
});
});
Loading

0 comments on commit 4cb5da4

Please sign in to comment.