Update README.md, AssemblyInfo, App.config in preparation for 1.0 rel…

…ease
jpdillingham · Jul 2, 2017 · a57b1be · a57b1be
1 parent 581ac90
commit a57b1be
Show file tree

Hide file tree

Showing 3 changed files with 84 additions and 4 deletions.
diff --git a/FileHistorian/App.config b/FileHistorian/App.config
@@ -11,7 +11,8 @@
   <fileHistorian>
     <ScanTime midnightOffset="00:00:00" />
     <Directories>
-      <add path="c:\pkg\" />
+      <add path="c:\dir\" />
+      <add path="c:\directory 2\" />"
     </Directories>
   </fileHistorian>
   <entityFramework>

diff --git a/FileHistorian/Properties/AssemblyInfo.cs b/FileHistorian/Properties/AssemblyInfo.cs
@@ -2,7 +2,7 @@
 using System.Runtime.InteropServices;
 
 [assembly: AssemblyTitle("FileHistorian")]
-[assembly: AssemblyDescription("")]
+[assembly: AssemblyDescription("An application to keep track of changes to a filesystem.")]
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("")]
 [assembly: AssemblyProduct("FileHistorian")]
@@ -11,5 +11,5 @@
 [assembly: AssemblyCulture("")]
 [assembly: ComVisible(false)]
 [assembly: Guid("064663fe-2cf1-4ca2-af68-b40ee4e8f48d")]
-[assembly: AssemblyVersion("0.9.0.0")]
-[assembly: AssemblyFileVersion("0.9.0.0")]
+[assembly: AssemblyVersion("1.0.0.0")]
+[assembly: AssemblyFileVersion("1.0.0.0")]
diff --git a/README.md b/README.md
@@ -6,3 +6,82 @@
 
 A C# .NET application to keep track of changes to a filesystem.
 
+## Why?
+
+To keep track of which files are added, deleted and modified on your computer.
+
+## Installation
+
+Download the [latest release](https://github.com/jpdillingham/FileHistorian/releases) and extract it to the target machine.
+
+The application will run in daemon mode by default, meaning scans will be executed once per day at the configured offset time.  
+
+A single scan can be performed using the ```--run-once``` argument, allowing for greater scheduling flexibility when combined with the Windows task scheduler or Unix Cron.
+
+To install the application as a service on Windows platforms, execute the following command:
+
+```
+ FileHistorian.exe --install-service
+ ```
+
+ This will install a Windows service named "FileHistorian", which can then be started from the Services console or by issuing the command ```net start FileHistorian``` from a command line.
+
+ ## Configuration
+
+ All configuration settings are stored in ```FileHistorian.exe.config```, located in the root application directory.
+
+ ### Application
+
+ The ```fileHistorian``` section contains all application settings:
+
+ ```xml
+   <fileHistorian>
+    <ScanTime midnightOffset="00:00:00" />
+    <Directories>
+      <add path="c:\dir\" />
+      <add path="c:\directory 2\" />
+    </Directories>
+  </fileHistorian>
+ ```
+
+ The ```ScanTime``` element is used to determine when the daily scan is to be started.  The ```midnightOffset``` attribute is the time span from midnight of the current day at which the scan is to start.
+
+ For example, if you want the scan to begin at 3:30 AM, the ```ScanTime``` element would look like the following:
+
+ ```xml
+ <ScanTime midnightOffset="03:30:00" />
+ ```
+
+ The ```Directories``` element contains the list of directories to be scanned, in the order in which they are to be scanned.
+
+ ### Database
+
+ The Entity Framework configuration section must be modified to reflect your database configuration.  The default configuration is for SQL server:
+
+ ```xml
+   <entityFramework>
+    <defaultConnectionFactory type="System.Data.Entity.Infrastructure.SqlConnectionFactory, EntityFramework">
+      <parameters>
+        <parameter value="Server=SQL;Database=FileHistorian;User=FileHistorian;Password=FileHistorian;" />
+      </parameters>
+    </defaultConnectionFactory>
+    <providers>
+      <provider invariantName="System.Data.SqlClient" type="System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer" />
+    </providers>
+  </entityFramework>
+ ```
+
+ Simply change the connection string to reflect your environment.  
+
+ Entity Framework is capable of connecting to all sorts of databases, however the application is currently only tooled for SQL server.  If you'd like support for a different platform please open an [issue](https://github.com/jpdillingham/FileHistorian/issues)
+ listing your desired platform and I'll do my best to incorporate it.
+
+## Roadmap
+
+- [x] Basic scaffolding (service implementation, cross cutting concerns)
+- [x] Data (Entity Framework implementation)
+- [x] Scanning
+- [ ] Detailed scan scheduling
+- [ ] Diff (scan comparison) functionality/CLI
+- [ ] Web service(s)
+- [ ] Web UI