Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Julusian authored Jul 22, 2023
1 parent 0dc33eb commit 1c19ba4
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# @companion-module/base

If you have found this without being directed here, then this is not for you.
Companion 3.0 is not ready for users yet, so you should not be targetting a module to it yet. We will make some announcements when we are ready

This module provides the base class and framework needed to write a module for [Companion 3.0](https://github.com/bitfocus/companion) and later in NodeJS.

In the future it will be possible to write modules in other languages, but it is not recommended as it will reduce the change of gettings other in the community to contribute features and fixes. If you interested in doing this then reach out and we can work together on creating an alternate framework for the language you are using.
Expand All @@ -11,7 +8,7 @@ In the future it will be possible to write modules in other languages, but it is

To get started with creating a new module, you should start with one of the following templates. These should be kept up to date, but you should make sure all the dependencies are up to date before you begin.

- TODO
- https://github.com/bitfocus/companion-module-template

## Documentation

Expand Down

0 comments on commit 1c19ba4

Please sign in to comment.