Skip to content

Commit

Permalink
Update project files and version to 1.0.2
Browse files Browse the repository at this point in the history
- Enhanced README with installation instructions and usage details.
- Updated CHANGELOG to reflect version 1.0.2 changes.
- Added LICENSE file with MIT License.
- Updated package.json to version 1.0.2 with accurate metadata and dependencies.
- Regenerated package-lock.json to match the updated package.json.
  • Loading branch information
Ali Jaradat committed Aug 15, 2024
1 parent 0091449 commit b7e4dc1
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 11 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

All notable changes to this project will be documented in this file.

## [1.0.2] - 2024-08-16

- `package.json` enhancements:
- Added `repository`, `homepage`, `bugs`, and `bin` fields.
- Improved `keywords` for better discoverability.
- Added a `start` script for easier execution.
- Addressed minor issues in the installation process.
- Updated README with additional instructions for dependencies.

## [1.0.1] - 2024-08-15

- Initial README and CHANGELOG files.
Expand Down
9 changes: 9 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MIT License

Copyright (c) 2024 Ali M. Jaradat

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,48 @@ git clone https://github.com/AmJaradat01/awesome-lazy-zsh.git
cd awesome-lazy-zsh
```

1. Run the setup script:
2. Install dependencies:

```bash
npm install
```

3. Run the setup script:

```bash
node awesome-lazy-zsh.js
```

or

```bash
npm start
```

## Usage

1. Choose Installation Type: Select between Default Installation or Custom Installation.
2. Select Theme: Choose your desired theme (e.g., Powerlevel10k, Spaceship, Starship). // default: Spaceship
3. Select Plugins: Select plugins from a list, or fetch additional plugins from the Oh-My-Zsh wiki.
4. Customize Aliases and Functions: Optionally customize aliases and functions in your `.zshrc`.
1. **Choose Installation Type:** Select between Default Installation or Custom Installation.
2. **Select Theme:** Choose your desired theme (e.g., Powerlevel10k, Spaceship, Starship). // default: Spaceship
3. **Select Plugins:** Select plugins from a list, or fetch additional plugins from the Oh-My-Zsh wiki.
4. **Customize Aliases and Functions:** Optionally customize aliases and functions in your `.zshrc`.

## Requirements

- Node.js
- Git
- Homebrew (automatically installed if not present)

## Compatibility

- macOS
- Linux (Not tested yet)

## Troubleshooting

- **Permissions Issues:** If you encounter permissions issues during installation, try running the commands with sudo.
- **Missing Dependencies:** Ensure that Node.js, Git, and Homebrew are correctly installed on your system.
- **Path Issues:** If commands aren't recognized, make sure your PATH environment variable is correctly set. You may need to restart your terminal or run source ~/.zshrc.

## License

This project is licensed under the MIT License.
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
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.

22 changes: 19 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,33 @@
{
"name": "awesome-lazy-zsh",
"version": "1.0.0",
"version": "1.0.2",
"description": "Awesome-Lazy-Zsh is an all-in-one, customizable Zsh setup tool designed to enhance your terminal experience.",
"main": "awesome-lazy-zsh.js",
"type": "module",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"start": "node awesome-lazy-zsh.js"
},
"keywords": [
"zsh"
"zsh",
"oh-my-zsh",
"terminal",
"customization",
"setup",
"automation"
],
"author": "Ali M. Jaradat <AmJaradat01@gmail.com>",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/AmJaradat01/awesome-lazy-zsh.git"
},
"homepage": "https://github.com/AmJaradat01/awesome-lazy-zsh",
"bugs": {
"url": "https://github.com/AmJaradat01/awesome-lazy-zsh/issues"
},
"bin": {
"awesome-lazy-zsh": "./awesome-lazy-zsh.js"
},
"dependencies": {
"axios": "^1.7.4",
"chalk": "^5.3.0",
Expand Down

0 comments on commit b7e4dc1

Please sign in to comment.