Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Some improvements for README.md #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbrilRBS merged 2 commits into from
Jun 3, 2025
Merged

Some improvements for README.md #20

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93defe6
add badges and more
czoido Jun 3, 2025
c4984dd
minor changes
czoido Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 48 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
# tome 📖

**tome** is a powerful script management tool designed to streamline the organization and
distribution of scripts across different environments. Built with flexibility and ease of
use in mind, **tome** enhances the way scripts of any kind are managed, shared, tested,
and maintained.
[![PyPI version](https://badge.fury.io/py/tomescripts.svg)](https://badge.fury.io/py/tomescripts)
[![CI Status](https://github.com/jfrog/tome/actions/workflows/main.yml/badge.svg)](https://github.com/jfrog/tome/actions/workflows/main.yml)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

**tome** is a powerful script management tool designed to streamline the
organization and distribution of scripts across different environments. Built
with flexibility and ease of use in mind, **tome** enhances how scripts of any
kind are managed, shared, tested, and maintained.

With **tome**, you can:

- **Organize** 📂: Effortlessly manage and structure your scripts for a clean, maintainable codebase.
- **Collaborate** 🤝: Seamlessly share and collaborate on scripts with your team to enhance productivity.
- **Test** 🧪: Ensure your scripts' reliability and performance with comprehensive testing tools.
- **Secure** 🔒: Manage and protect your passwords using the **tome** vaults.
* **Organize** 📂: Effortlessly manage and structure your scripts for a clean,
maintainable codebase. [Learn more in the Quickstart →](https://jfrog.github.io/tome/latest/overview/quickstart/)
* **Share & Collaborate** 🤝: Seamlessly distribute your script collections
(Tomes) via Git, archives, or local folders. [See sharing options →](https://jfrog.github.io/tome/latest/guides/share/)
* **Test** 🧪: Ensure your scripts' reliability with integrated `pytest`
support. [Read the testing guide →](https://jfrog.github.io/tome/latest/guides/testing/)
* **Secure** 🔒: Manage and protect sensitive data like API keys and passwords
using the **tome** Vault. [Explore the Vault →](https://jfrog.github.io/tome/latest/guides/features/vault/)

---

## Installation

Expand Down Expand Up @@ -41,7 +51,36 @@ source myenv/bin/activate
pip install tomescripts
```

4. Now you can start using **tome**
You're all set to start using **tome**!

---

## Quick Example: Hello Tome!

Get a feel for **tome** in under a minute:

```console
# 1. Create a new command template
$ tome new greetings:hello

# 2. Install your new Tome (in editable mode for development)
$ tome install . -e

# 3. Run your command!
$ tome greetings:hello "Hello"
_______
< Hello >
-------
\\ @..@
\\ (----)
( >__< )
^^ ~~ ^^
```

This simple example creates a Python script that prints a greeting with an ASCII
frog. With **tome**, this script is now an easily callable command.

---

## Documentation

Expand Down
Loading