Skip to content

Commit

Permalink
docs: update index page
Browse files Browse the repository at this point in the history
  • Loading branch information
rick-jennings committed Oct 10, 2024
1 parent 7dfe9c9 commit 7253f44
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
# Welcome

**Note:** More information will be coming soon!

## About

Phable is an open source, simple, modern Python toolkit for basic client connectivity to a [Project Haystack](https://project-haystack.org/) defined server application.
Phable is an open source, simple, modern Python toolkit for basic client connectivity to [Project Haystack](https://project-haystack.org/) and [Haxall](https://haxall.io/) defined server applications.

Phable is free to use and permissively licensed under the MIT license.

Project Haystack features include:

- Reading `site`, `equip`, and `point` entities
- Reading current values of real-time data points
- Supervisory control of real-time data points
- Reading history data for data points
- Writing history data to already established data points

Haxall features include:

- All Project Haystack features listed above
- Add, update, and remove commit operations
- Evaluation of an Axon string expression

Learn more about `Phable` by exploring the documentation!

0 comments on commit 7253f44

Please sign in to comment.