Prep for app-store

Author: clayandgen

README.md

@@ -1,66 +1,38 @@
-# OpenC3 COSMOS Plugin
+# OpenC3 COSMOS Trends
 
-See the [OpenC3](https://openc3.com) documentation for all things OpenC3.
+A trend analysis tool for [OpenC3 COSMOS](https://openc3.com). Upload telemetry CSV data, fit trend models, and forecast future values.
 
-Update this comment with your own description.
+![Trends Tool](public/store_img.png)
 
-## Getting Started
+## Features
 
-1. Edit the .gemspec file fields: name, summary, description, authors, email, and homepage
-1. Update the LICENSE.md file with your company name
+- **Upload CSV** — Import data exported from Data Extractor (timestamp + numeric columns)
+- **9 Trend Models** — Linear, Polynomial, Exponential, Logarithmic, Power, Sinusoidal, Simple Moving Average, Exponential Moving Average, Holt's Linear
+- **Forecasting** — Predict ahead with configurable time horizon
+- **Threshold Crossing** — Set a threshold and see when the trend is predicted to reach it
+- **Export** — Save charts as PNG or trend data as CSV
 
-## Building non-tool / widget plugins
-
-1. <Path to COSMOS installation>/openc3.sh cli rake build VERSION=X.Y.Z (or openc3.bat for Windows)
-   - VERSION is required
-   - gem file will be built locally
-
-## Building tool / widget plugins using a local Ruby/Node/pnpm/Rake Environment
-
-1. pnpm install --frozen-lockfile --ignore-scripts
-1. rake build VERSION=1.0.0
-
-## Building tool / widget plugins using Docker and the openc3-node container
-
-If you don’t have a local node environment, you can use our openc3-node container to build custom tools and custom widgets
-
-Mac / Linux:
+## Building
 
 ```
-docker run -it -v `pwd`:/openc3/local:z -w /openc3/local docker.io/openc3inc/openc3-node sh
+pnpm install --frozen-lockfile --ignore-scripts
+rake build VERSION=1.0.0
 ```
 
-Windows:
+Or using Docker:
 
 ```
-docker run -it -v %cd%:/openc3/local -w /openc3/local docker.io/openc3inc/openc3-node sh
+docker run -it -v `pwd`:/openc3/local:z -w /openc3/local docker.io/openc3inc/openc3-node sh
+pnpm install --frozen-lockfile --ignore-scripts
+rake build VERSION=1.0.0
 ```
 
-1. pnpm install --frozen-lockfile --ignore-scripts
-1. rake build VERSION=1.0.0
-
-## Installing into OpenC3 COSMOS
+## Installing
 
 1. Go to the OpenC3 Admin Tool, Plugins Tab
-1. Click the install button and choose your plugin.gem file
-1. Fill out plugin parameters
-1. Click Install
-
-## Contributing
-
-We encourage you to contribute to OpenC3!
-
-Contributing is easy.
-
-1. Fork the project
-2. Create a feature branch
-3. Make your changes
-4. Submit a pull request
-
-Before any contributions can be incorporated we do require all contributors to agree to a Contributor License Agreement
-
-This protects both you and us and you retain full rights to any code you write.
+2. Click Install and choose the `.gem` file
+3. Fill out plugin parameters and click Install
 
 ## License
 
-This OpenC3 plugin is released under the MIT License. See [LICENSE.md](LICENSE.md)
+Released under the MIT License. See [LICENSE.md](LICENSE.md).

openc3-cosmos-trends.gemspec

@@ -3,9 +3,9 @@
 # Create the overall gemspec
 Gem::Specification.new do |s|
   s.name = 'openc3-cosmos-trends'
-  s.summary = 'Trend Analysis and Prediction'
+  s.summary = 'Trend Analysis'
   s.description = <<-EOF
-    Tool to help analyze trends and make simple predictions based on historical telemetry.
+    Tool to analyze trends and make simple predictions based on historical data.
   EOF
   s.license = 'MIT'
   s.authors = ['Clay Kramp']
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.required_ruby_version = '>= 3.0'
     s.metadata = {
-    'openc3_store_keywords' => 'trends,graph,analysis',
+    'openc3_store_keywords' => 'trends,graph,analysis,prediction',
     'source_code_uri' => 'https://github.com/clayandgen/openc3-cosmos-trends',
     'openc3_store_access_type' => 'public'
   }