diff --git a/projectNotes.md b/projectNotes.md index 76c9e7f1..a8fdd071 100644 --- a/projectNotes.md +++ b/projectNotes.md @@ -1,5 +1,15 @@ -# ipfs Stat Viewer Project Notes +# IPFS-Stat-Viewer Project Notes +## User Interface Updates +### File_Name Improvements +Right now the filename is within each box within the treemap. The problem is when there are many files or the files are small, then you cannot see the name. Find a better way to handle this. +- Explore the best ways to show the name of a file within a treemap- look at other software +- Implement UI improvements +### Firefox Integration +- isues created and added into project +### Chrome Integration + +- Fix icons ## High-Value Information Points -## High-Value Information Visualazations +## High-Value Information Visualizations diff --git a/readme.md b/readme.md index b3d5248e..0cca9b25 100644 --- a/readme.md +++ b/readme.md @@ -14,12 +14,14 @@ [Download in the Google Chrome Store](https://chrome.google.com/webstore/detail/ipfs-stat-viewer/leoogniilogpecgamlbafoajfcaoddja) +Important Note: You need to make sure you have cross origin requests allowed. You can use the following ipfs cli-commands to enable cross origin access. + +If If you want to install from source via this repo, do the following- - Download the build file and load it as unpacked in Chrome Extension Manager - Open extension with your IPFS Daemon running -Important Note: You need to make sure you have cross origin requests allowed. You can use the following ipfs cli-commands to enable cross origin access. ```sh @@ -33,12 +35,12 @@ As as you have IPFS running, it should work without issue- - You should see something that looks like this depending on what you have pinned in IPFS ## Features -- Colors of boxes in treemap correlate to a file type- supporting music, picture, video, extension types and many more. +- Colors of boxes in treemap correlate to a file type- supporting music, photos, video, and more. - Box size correlates to amount of data in the file ## Tech - A users IPFS data is visualized using organized colorful graphics similar to apps like Windirstat, Spacesniffer, or Disk Recon. Each file type (MP3, ZIP, EXE, JPEG, etc.) is assigned a color in a collage of rectangles that are sized depending on how much space that file type is using. Treemap function provided by D3.js. + A users IPFS data is visualized using organized colorful graphics similar to apps like Windirstat, or Disk Recon. Each file type (MP3, ZIP, EXE, JPEG, etc.) is assigned a color in a collage of rectangles that are sized depending on how much space that file type is using. Treemap function provided by D3.js. - [IPFS] - Peer-to-peer hypermedia protocol - [D3] - A Javascript library for visualizing data using web standards-