diff --git a/README.md b/README.md index 3f7738b..b0a801a 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ -# RepoForge: Scaffold Your Project With Ease and Speed +# Terox: Scaffold Your Project With Ease and Speed -RepoForge is a CLI tool to scaffold projects from pre-built templates. Invoke -RepoForge with a path to a template (either local or online) and watch your +Terox is a CLI tool to scaffold projects from pre-built templates. Invoke +Terox with a path to a template (either local or online) and watch your project get scaffolded automatically. Setting up projects from scratch and in a -reproducible manner is time-consuming and difficult and that is where RepoForge +reproducible manner is time-consuming and difficult and that is where Terox will prove most helpful. -## Why RepoForge Exists +## Why Terox Exists -Development on RepoForge is heavily inspired from existing tools like +Development on Terox is heavily inspired from existing tools like [Create-React-App (CRA)](https://create-react-app.dev), [Cookiecutter](https://cookiecutter.readthedocs.io) and the likes. While the existing tools have their use cases and they fulfill their roles quite aptly, -RepoForge aims to resolve the following pain points: +Terox aims to resolve the following pain points: 1. The need for a cross-platform and distributable binary executable unlike Cookiecutter which requires [Python](https://www.python.org) (or @@ -30,22 +30,22 @@ RepoForge aims to resolve the following pain points: wanted a more universal tool to get a similar job done quickly and efficiently. -## Functionalities of RepoForge +## Functionalities of Terox -**NOTE**: RepoForge is still a WIP project in its very initial phase and is not stable. Hence, +**NOTE**: Terox is still a WIP project in its very initial phase and is not stable. Hence, its UI/UX elements are subject to change without prior notice. We request you to -try out the pre-release versions of RepoForge and provide us with feedback. Any +try out the pre-release versions of Terox and provide us with feedback. Any feedback, no matter how trivial will help us improve the experience of the tool significantly! -That said, RepoForge provides the following core functionalities: +That said, Terox provides the following core functionalities: 1. The ability to scaffold a project based on a pre-existing template (hosted - either on GitHub or some archived file elsewhere). RepoForge will be able to + either on GitHub or some archived file elsewhere). Terox will be able to fetch Git repositories from anywhere as long as the remote repository supports the Git protocol. 2. Help the user create templates which will be used in the future for - scaffolding more projects. Do note though, RepoForge is not intelligent + scaffolding more projects. Do note though, Terox is not intelligent enough to decide what the template is supposed to be like, some manual tinkering will still be required from the user's end! @@ -59,7 +59,7 @@ That said, RepoForge provides the following core functionalities: ## Licensing and Distribution Rights -RepoForge is developed and open-sourced under a public open-source license (the +Terox is developed and open-sourced under a public open-source license (the MIT license). Hence, you are free to use, copy and distribute the code for the project under the terms of conditions of the aforementioned license. For more information on the licensing details, refer to the [LICENSE](./LICENSE)