diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cdf4fc6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +Contributions are welcome. + +You can either open a pull request or open an issue if you have an idea. + +There are 2 main branches +- `master` - used for stable releases +- `develop` - used for active development + +Feature branches should be created from the `develop` branch. + +Hotfix branches should be created from the `master` branch. diff --git a/README.md b/README.md index 7de7c11..8d2f93a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This concept is very similar to [Stem](https://github.com/alvinl/stem), however ## Core -Vapor's core (represented by this repo) provides a very simple automated client. This client uses [node-steam](https://github.com/seishun/node-steam) (extended by [node-steam-groups](https://github.com/scholtzm/node-steam-groups)) to connect to Steam servers. +Vapor's core (represented by this repo) provides a very simple automated client. This client uses [node-steam](https://github.com/seishun/node-steam) (extended with [node-steam-groups](https://github.com/scholtzm/node-steam-groups)) to connect to Steam servers. Core represents several key features: - easy to update and does not have to be modified by the user