Skip to content
This repository was archived by the owner on Mar 6, 2024. It is now read-only.

Commit 1f20568

Browse files
authored
Update README.md
1 parent a258e2b commit 1f20568

File tree

1 file changed

+35
-14
lines changed

1 file changed

+35
-14
lines changed

README.md

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,33 @@ NOTE
55
---------------
66
SmartSweeper is still in the development stage so it is unstable and missing functionality. DO NOT attempt to create transactions with this app.
77

8+
89
Description
910
---------------
10-
Sweeper application for [SmartCash cryptocurrency](http://smartcash.cc) to allow easy retrieval of gift funds. Runs on Windows, Linux, and Mac OS. It isn't necessary to input your wallet passphrase to use SmartSweeper.
11+
Sweeper application for [SmartCash cryptocurrency](http://smartcash.cc) to allow easy retrieval of gift funds. Runs only on Windows at the moment. It isn't necessary to input your wallet passphrase to use SmartSweeper.
12+
13+
14+
Features
15+
---------------
16+
* Create projects to organize promotions
17+
* Send funds to multiple promotional wallets
18+
* Retrieve promotional funds from wallets that were not redeemed
19+
* Print paper wallets
20+
* Access logs
21+
1122

1223
Releases
1324
---------------
1425
Releases are forthcoming. Please see the [dev branch](https://github.com/swiftlettech/smart-sweeper/tree/dev).
1526

27+
1628
Requirements
1729
---------------
1830
* [Node.js](http://nodejs.org) - 8.9.0+
1931
* [npm](http://npmjs.com) - 5.6.0+
20-
* [SmartCash wallet](https://smartcash.cc/wallets/) for Windows, Linux, or Mac OS - 1.1.1+ ([there is a bootstrap file to shorten sync time](https://smartcash.freshdesk.com/support/solutions/articles/35000027174-using-the-bootstrap-to-speedup-sync-process))
32+
* [SmartCash Node Client](https://smartcash.cc/wallets/) for Windows - 1.2.2+ ([there is a bootstrap file to shorten sync time](https://smartcash.freshdesk.com/support/solutions/articles/35000027174-using-the-bootstrap-to-speedup-sync-process))
2133

22-
Run node -v and npm -v from a command prompt to make sure they're in your PATH. Open your wallet to make sure that it is up to date before launching SmartSweeper.
34+
Run node -v and npm -v from a command prompt to make sure they're in your PATH. Open your SmartCash desktop wallet application to make sure it is up to date before launching SmartSweeper.
2335

2436

2537
Installation
@@ -47,16 +59,16 @@ rpc.password=rpcpassword
4759
smartcashPath=C:\Program Files\SmartCash\
4860
```
4961

50-
* rpc.host is the IP address that the SmartCash Wallet RPC server is bound to.
51-
* rpc.port is the port that the SmartCash Wallet RPC server is listening on.
52-
* rpc.username is the SmartCash Wallet RPC server username.
53-
* rpc.password is the SmartCash Wallet RPC server password.
54-
* smartcashPath is the full path to your SmartCash Wallet installation. You must include a trailing slash.
62+
* rpc.host is the IP address that the SmartCash Node Client RPC server is bound to.
63+
* rpc.port is the port that the SmartCash node client RPC server is listening on.
64+
* rpc.username is the SmartCash Node Client RPC server username.
65+
* rpc.password is the SmartCash Node Client RPC server password.
66+
* smartcashPath is the full path to your SmartCash Node Client installation. You must include a trailing slash.
5567

5668

5769
Your SmartCash wallet must be started with the following arguments:
5870
```
59-
-txindex=1
71+
-txindex=1 (if SmartCash Node Client is < v1.2.3)
6072
-server
6173
-rpcbind=127.0.0.1
6274
-rpcport=9678
@@ -67,7 +79,7 @@ Your SmartCash wallet must be started with the following arguments:
6779
If it isn't running, SmartSweeper will start it for you with the above arguments. You can also [edit your wallet's smartcash.conf file](https://smartcash.freshdesk.com/support/solutions/articles/35000038702-smartcash-conf-configuration-file). Please don't do this with your wallet running.
6880

6981
```
70-
txindex=1
82+
txindex=1 (if SmartCash Node Client is < v1.2.3)
7183
server=1
7284
rpcbind=127.0.0.1
7385
rpcport=9678
@@ -83,16 +95,23 @@ User files
8395
The database (smart-sweeper.json), the app config file (smart-sweeper-config.json) and the log files are saved in the following folders:
8496

8597
* **Windows**: %APPDATA%/SmartSweeper
86-
* **Linux**: $XDG_CONFIG_HOME/smart-sweeper or ~/.config/SmartSweeper
87-
* **Mac**: ~/Library/Application Support/SmartSweeper
8898

89-
The log files are also in JSON format and can be read with a general log viewer such as [glogg](https://github.com/nickbnf/glogg).
99+
The log files are also in JSON format and can be viewed with a general log viewer such as [glogg](https://github.com/nickbnf/glogg). **It is recommended that you back up smart-sweeper.json to a safe place.**
100+
101+
102+
KNOWN ISSUES
103+
---------------
104+
* electron-store error: "EPERM operation not permitted" sometimes occurs on Windows when reading a config file. SmartSweeper will exit when it does.
90105

91106

92107
Other software used
93108
-------------------
94109
Software | License
95110
-------- | --------
111+
[AngularJS](http://angularjs.org) | MIT
112+
[AngularUI Bootstrap](https://github.com/angular-ui/bootstrap) | MIT
113+
[Bootstrap](https://getbootstrap.com/docs/3.3/) | MIT
114+
[clipboard.js](https://clipboardjs.com) | MIT
96115
[devtron](https://github.com/electron/devtron) | MIT
97116
[electron](https://github.com/electron/electron) | MIT
98117
[electron-debug](https://github.com/sindresorhus/electron-debug) | MIT
@@ -104,8 +123,10 @@ Software | License
104123
[melanke-watchjs](https://github.com/melanke/Watch.JS) | MIT
105124
[node-smartcash](https://github.com/miyakoj/node-smartcash) | MIT
106125
[ps-node](https://github.com/neekey/ps) | MIT
126+
[request](https://github.com/request/request) | Apache-2.0
107127
[smartcashjs-lib](https://github.com/SmartCash/SmartCashjs-lib) | MIT
108128
[SmartCash Paper Wallet Generator](https://github.com/SmartCash/PaperWalletGenerator) | ?
109129
[winston](https://github.com/winstonjs/winston) | MIT
110130

111-
[The SmartExplorer API](http://explorer3.smartcash.cc) is used to check the current block count and to get info about project addresses.
131+
132+
[The SmartCash Insight Explorer API](https://insight.smartcash.cc) is used to check the current block count and to get information about project addresses.

0 commit comments

Comments
 (0)