Skip to content

Commit

Permalink
🚀 v2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
shravanasati committed May 9, 2021
1 parent 2bb217e commit ff3a128
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 18 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,10 @@
- CI build bug fix (redefined embed paths for licenses and gitignores)

## v2.1.0 (28/4/2021)
- Added support for web as a language type for project initialisation
- Added support for web as a language type for project initialisation

## v2.2.0 (9/5/2021)
- Added flask (python web framework), C, C++, and ruby as language types for project initialisation
- Improved web initialisation
- Added support for Unilicense
- Changed the hydra config directory
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,13 @@ This section shows how you can setup your development environment to contribute
- Fork the repository.
- Clone it using Git (`git clone https://github.com/<YOUR USERNAME>hydra.git`).
- Create a new git branch (`git checkout -b "BRANCH NAME"`).
- Install `commando` module using the command `go get github.com/thatisuday/commando`.
- Install the `commando` module using the command `go get github.com/thatisuday/commando`.
- Make changes.
- Stage and commit (`git add .` and `git commit -m "COMMIT MESSAGE"`).
- Push it your remote repository (`git push`).
- Open a pull request by clicking [here](https://github.com/Shravan-1908/hydra/compare).


## Reporting Issues
If you know a bug in the code or you want to file a feature request, open an issue.
Choose the correct issue template from [here](https://github.com/Shravan-1908/hydra/issues/new/choose).
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 Shravan
Copyright (c) 2021-Present Shravan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
47 changes: 34 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,35 @@
## ⚡️ Installation
### Method 1

Linux/Mac users can download hydra using the executing the following command in bash:
**For Linux users:**

Execute the following command in bash:

```bash
curl https://raw.githubusercontent.com/Shravan-1908/hydra/main/linux_install.sh | sudo bash -
```

For Windows users:

Open powershell as Admin and execute the following command:
**For MacOS users:**

Execute the following command in bash:

```bash
curl https://raw.githubusercontent.com/Shravan-1908/hydra/main/macos_install.sh | sudo bash -
```

**For Windows users:**

Open Powershell **as Admin** and execute the following command:
```powershell
Set-ExecutionPolicy Bypass -Scope Process -Force; (Invoke-WebRequest -Uri https://raw.githubusercontent.com/Shravan-1908/hydra/main/windows_install.ps1 -UseBasicParsing).Content | powershell -
```

To verify installation of *hydra*, open a new shell and execute `hydra -v`. You should see output like this:
To verify the installation of *hydra*, open a new shell and execute `hydra -v`. You should see output like this:
```
hydra 2.0.0
hydra 2.2.0
Version: 2.0.0
Version: 2.2.0
```
If the output isn't something like this, you need to repeat the above steps carefully.

Expand All @@ -49,7 +60,7 @@ If you've Go installed on your system, execute:

`go get github.com/Shravan-1908/hydra`

You don't need to change the PATH variable in this case, as Go will automatically build and add the executable in the $GOPATH/bin directory.
You don't need to change the PATH variable in this case, as Go will automatically build and add the executable in the `$GOPATH/bin` directory.

<br>

Expand All @@ -72,6 +83,10 @@ It is used to initiate the modules in go.
* go
* python
* web
* flask
* c
* c++
* ruby

- `default-license` --> The default license for project creation. Valid values are:
* MIT
Expand All @@ -80,6 +95,7 @@ It is used to initiate the modules in go.
* APACHE
* EPL
* MPL
* UNI

Once hydra is installed, it is advised to run the following command to complete the configuration.

Expand Down Expand Up @@ -111,12 +127,15 @@ Valid options for the language argument are:
- python
- go
- web
- flask
- c
- c++
- ruby

Example: `hydra init myProject python`

In case the `lang` argument is not provided, hydra falls back to the `default-lang` configuration.

*hydra* currently supports only python, go and web-frontend for project creation. But, as new versions are released, support for more languages/frameworks will be added.


### version
Expand All @@ -132,17 +151,19 @@ Renders assistance for *hydra* on a terminal, briefly showing its usage.
<br>

## ⏩ Change Log
The changes made in the latest version of hydra, *v2.0.1* are:
The changes made in the latest version of hydra, *v2.2.0* are:

- Made a separate 'list.go' file for the `list` command
- CI build bug fix (redefined embed paths for licenses and gitignores)
- Added flask (python web framework), C, C++, and ruby as language types for project initialisation
- Improved web initialisation
- Added support for Unilicense
- Changed the hydra config directory

View [CHANGELOG.md](CHANGELOG.md) for more information.

<br>

## 🔖 Versioning
*hydra* releases follow semantic versioning, where every release is in the *x.y.z* form, where:
*hydra* releases follow semantic versioning, every release is in the *x.y.z* form, where:
- *x* is the MAJOR version and is incremented when a backwards incompatible change to hydra is made.
- *y* is the MINOR version and is incremented when a backwards compatible change to hydra is made, like changing dependencies or adding a new function, method, struct field, or type.
- *z* is the PATCH version and is incremented after making minor changes that don't affect hydra's public API or dependencies, like fixing a bug.
Expand All @@ -151,7 +172,7 @@ View [CHANGELOG.md](CHANGELOG.md) for more information.

## 📄 License
License
© 2021 Shravan Asati
© 2021-Present Shravan Asati

This repository is licensed under the MIT license. See [LICENSE](LICENSE) for details.

Expand Down
9 changes: 7 additions & 2 deletions linux_install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@
echo "Downloading hydra..."
curl -L "https://github.com/Shravan-1908/hydra/releases/latest/download/hydra-linux-amd64" -o hydra

echo "Placing hydra into PATH..."
mv ./hydra /bin
echo "Adding hydra into PATH..."

mkdir -p ~/.hydra

chmod u+x ./hydra

mv ./hydra ~/.hydra
echo "export PATH=$PATH:~/.hydra" >> ~/.bashrc

echo "hydra installation is completed!"
echo "You need to restart the shell to use hydra."
14 changes: 14 additions & 0 deletions macos_install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

#!/bin/bash

echo "Downloading hydra..."
curl -L "https://github.com/Shravan-1908/hydra/releases/latest/download/hydra-darwin-amd64" -o hydra

echo "Adding hydra into PATH..."

mkdir -p ~/.hydra;
mv ./hydra ~/.hydra
echo "export PATH=$PATH:~/.hydra" >> ~/.bashrc

echo "hydra installation is completed!"
echo "You need to restart the shell to use hydra."

0 comments on commit ff3a128

Please sign in to comment.