Skip to content

Update README to reflect latest changes #205

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 23, 2024
Merged

Update README to reflect latest changes #205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ import { updateChangelog } from '@metamask/auto-changelog';
const oldChangelog = await fs.readFile('CHANGELOG.md', {
encoding: 'utf8',
});
const updatedChangelog = updateChangelog({
const updatedChangelog = await updateChangelog({
changelogContent: oldChangelog,
currentVersion: '1.0.0',
repoUrl: 'https://github.com/ExampleUsernameOrOrganization/ExampleRepository',
Expand All @@ -122,7 +122,7 @@ const oldChangelog = await fs.readFile('CHANGELOG.md', {
encoding: 'utf8',
});
try {
validateChangelog({
await validateChangelog({
changelogContent: oldChangelog,
currentVersion: '1.0.0',
repoUrl:
Expand All @@ -139,7 +139,7 @@ try {

### Setup

- Install [Node.js](https://nodejs.org) version 14
- Install [Node.js](https://nodejs.org) version 18
- If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
- Install [Yarn v3](https://yarnpkg.com/getting-started/install)
- Run `yarn install` to install dependencies and run any required post-install scripts
Expand Down
Loading