Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bajdzis committed Jul 8, 2021
1 parent f3e687f commit 08d1394
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 12 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,35 @@
# Awesome Tree

engine:
[![Support this project](https://img.shields.io/badge/GitHub_Sponsors-Bajdzis-green)](https://github.com/sponsors/Bajdzis/)
[![Build Status](https://travis-ci.com/Bajdzis/vscode-awesome-tree.svg?branch=master)](https://travis-ci.com/Bajdzis/vscode-awesome-tree)
[![Coverage Status](https://coveralls.io/repos/github/Bajdzis/vscode-awesome-tree/badge.svg?branch=master)](https://coveralls.io/github/Bajdzis/vscode-awesome-tree?branch=master)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

<img src="https://github.com/Bajdzis/vscode-awesome-tree/raw/master/readme/awesome-tree-icon.png" alt="logo" style="max-width:100px">

Extension for Visual Studio Code which analyze your files content **on your computer**!
We analyze files content by whitespace indentation so we can supports all programming languages. Parse algorithm is available on NPM :

https://www.npmjs.com/package/awesome-tree-engine


[![Coverage Status](https://coveralls.io/repos/github/Bajdzis/awesome-tree/badge.svg?branch=master)](https://coveralls.io/github/Bajdzis/awesome-tree?branch=master)
![npm](https://img.shields.io/npm/v/awesome-tree-engine)


vscode extension:
## Features

[![Build Status](https://travis-ci.com/Bajdzis/vscode-awesome-tree.svg?branch=master)](https://travis-ci.com/Bajdzis/vscode-awesome-tree)
[![Coverage Status](https://coveralls.io/repos/github/Bajdzis/vscode-awesome-tree/badge.svg?branch=master)](https://coveralls.io/github/Bajdzis/vscode-awesome-tree?branch=master)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
- Create file content after creating a new file. We try to put the file name in the generated content.

![create file](https://github.com/Bajdzis/vscode-awesome-tree/raw/master/readme/create-file.gif)

### Extension for Visual Studio Code
- Create structure after creating new directory. We analyze siblings directories and create files with content.

![logo](https://github.com/Bajdzis/vscode-awesome-tree/raw/master/readme/awesome-tree-icon.png)
![create directory](https://github.com/Bajdzis/vscode-awesome-tree/raw/master/readme/create-directory.gif)

## Features
- You can compare files if you want to find out on what basis the content was generated.

- Create structure (file or directory) based on sibling directory
- Rename directory with file content
![compare files](https://github.com/Bajdzis/vscode-awesome-tree/raw/master/readme/compare-files.gif)

## How it work?

Expand Down
40 changes: 38 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,60 @@
{
"name": "awesome-tree",
"displayName": "Awesome tree",
"description": "Stop creating folders, start creating structures! (Automated file creation)",
"description": "Code completion plugin. Analyze your files content on your computer. We analyze files content by whitespace indentation so we can supports all programming languages.",
"version": "2.2.0",
"publisher": "bajdzis",
"author": {
"name": "Rafał Budzis",
"url": "https://budzis.pl"
"url": "https://github.com/Bajdzis/"
},
"engines": {
"vscode": "^1.57.1"
},
"categories": [
"Programming Languages",
"Snippets",
"Other"
],
"activationEvents": [
"*"
],
"badges": [
{
"url": "https://img.shields.io/badge/GitHub_Sponsors-Bajdzis-green",
"description": "Support this project",
"href": "https://github.com/sponsors/Bajdzis/"
}
],
"icon": "readme/awesome-tree-icon.png",
"keywords": [
"javascript",
"python",
"typescript",
"php",
"autocomplete",
"ruby",
"java",
"go",
"golang",
"bash",
"kotlin",
"html",
"css",
"ocaml",
"perl",
"rust",
"c",
"cpp",
"c++",
"csharp",
"c#",
"react",
"ai",
"method completion",
"intellicode",
"intellisense",
"snippets",
"file",
"files",
"dir",
Expand Down
Binary file added readme/compare-files.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/create-directory.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/create-file.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 08d1394

Please sign in to comment.