Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
kamilmielnik committed Nov 21, 2022
1 parent 1e24182 commit e125fa7
Showing 1 changed file with 49 additions and 8 deletions.
57 changes: 49 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,56 @@
# r-factor README
<div align="center">
<a href="https://r-factor.org">
<img src="https://raw.githubusercontent.com/limesquid/r-factor/master/logo.png" alt="R-Factor logo" />
</a>

R-Factor - React & Redux Refactoring Tools
<h1>R-Factor extension for Atom</h1>

## Features
<p>React & Redux Refactoring Tools</p>

For full list of features see https://r-factor.org/
<p>
<img src="https://img.shields.io/github/package-json/v/limesquid/r-factor-atom.svg" alt="Version" />
<a href="https://github.com/limesquid/r-factor-atom/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/limesquid/r-factor-atom" alt="license" />
</a>
</p>

## Requirements
<p>
<a href="https://r-factor.org">Website</a> | <a href="https://r-factor.org/documentation">Documentation</a>
</p>

- node.js 6.0.0+
<p>
<a href="https://github.com/limesquid/r-factor">R-Factor</a> | <a href="https://github.com/limesquid/r-factor-atom">Atom</a> | <a href="https://github.com/limesquid/r-factor-sublime">Sublime Text</a> | <a href="https://github.com/limesquid/r-factor-vscode">Visual Studio Code</a>
</p>
</div>

## Extension Settings
## Install

For full list of settings & documentation see https://r-factor.org/documentation/
### Stable version

```Shell
wget -c https://github.com/limesquid/r-factor-atom/archive/refs/tags/1.0.0.zip -O r-factor-atom.zip
mkdir -p ~/.atom/packages
unzip r-factor-atom.zip -d ~/.atom/packages
rm r-factor-atom.zip
mv ~/.atom/packages/r-factor-atom-1.0.0 ~/.atom/packages/r-factor-atom
cd ~/.atom/packages/r-factor-atom
npm install
```

### Latest (master)

```Shell
wget -c https://github.com/limesquid/r-factor-atom/archive/refs/heads/master.zip -O r-factor-atom.zip
mkdir -p ~/.atom/packages
unzip r-factor-atom.zip -d ~/.atom/packages
rm r-factor-atom.zip
mv ~/.atom/packages/r-factor-atom-master ~/.atom/packages/r-factor-atom
cd ~/.atom/packages/r-factor-atom
npm install
```

## Uninstall

```Shell
rm -rf ~/.atom/packages/r-factor-atom
```

0 comments on commit e125fa7

Please sign in to comment.