Skip to content

Commit

Permalink
Add: beta info in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NobleMajo committed May 15, 2024
1 parent 9bd0fec commit 95035ca
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# HiveSsh

# HiveSsh [(Beta)](#beta-info)
![CI/CD](https://github.com/noblemajo/hivessh/actions/workflows/npm-publish.yml/badge.svg)
![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
![typescript](https://img.shields.io/badge/dynamic/json?style=plastic&color=blue&label=Typescript&prefix=v&query=devDependencies.typescript&url=https%3A%2F%2Fraw.githubusercontent.com%2Fnoblemajo%2Fhivessh%2Fmain%2Fpackage.json)
Expand All @@ -13,9 +12,10 @@
![](https://img.shields.io/badge/dynamic/json?color=darkred&label=open%20issues&query=open_issues&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhivessh)

# Table of Contents
- [HiveSsh](#hivessh)
- [HiveSsh (Beta)](#hivessh-beta)
- [Table of Contents](#table-of-contents)
- [About](#about)
- [Beta info](#beta-info)
- [Key Features](#key-features)
- [Requirements](#requirements)
- [Getting started](#getting-started)
Expand All @@ -33,6 +33,12 @@ HiveSsh simplifies SSH2 connections via promise-based task execution on Linux se

HiveSsh is a library designed to streamline SSH2 connections and task execution on Linux servers. It provides user-friendly promise-based functions for efficient server operations without the need for a client application.

# Beta info
This software is yet not fully developed and will change over time.
If a version is intended to be used in another release, it is recommended to pin the dependency to a version to prevent beta breaking changes.

Feel free to test the software and submit suggestions for improvements or problems.

# Key Features
HiveSsh offers the following key features:
- __All-Distributions__: SSH2 and SFTP operations for all Linux servers
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hivessh",
"version": "0.3.1",
"version": "0.3.2",
"description": "HiveSsh simplifies SSH2 connections via promise-based task execution on Linux servers with built-in server utilities and powerful command execution functions",
"main": "dist/index.js",
"type": "module",
Expand Down

0 comments on commit 95035ca

Please sign in to comment.