Skip to content

Commit 2d39a84

Browse files
chore(docs): add some more instructions
1 parent acd5303 commit 2d39a84

2 files changed

Lines changed: 14 additions & 1 deletion

File tree

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2024 Ayushman Chhabra
3+
Copyright (c) 2026 Ayushman Chhabra
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of
66
this software and associated documentation files (the "Software"), to deal in

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Command line interface for building NW.js apps
55
## Getting Started
66

77
1. Install package: `npm i -g @nwutils/cli`
8+
1. Create a new project: `nw-cli create MyApp`
89

910
## CLI
1011

@@ -69,3 +70,15 @@ pollyfill();
6970

7071
* [ ] Add react-js template
7172
* [ ] Package custom node test coverage action.
73+
74+
## Contributing
75+
76+
### External contributor
77+
78+
- Use Node.js standard libraries whenever possible.
79+
- Prefer to use syncronous APIs over modern APIs which have been introduced in later versions.
80+
81+
### Maintainer
82+
83+
- npm trusted publishing is used for releases
84+
- a package is released when a maintainer creates a release note for a specific version

0 commit comments

Comments
 (0)