Skip to content

Commit d3e100f

Browse files
committed
updating readme for release
1 parent 769011d commit d3e100f

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,34 +42,39 @@ CAVEATS
4242

4343
* PROJECT STATUS: **BETA**
4444
* A `CUSTOM BUG-FIXED VERSION OF FUSEPY`_ IS REQUIRED FOR FULL POSIX COMPLIANCE.
45+
IT IS AUTOMATICALLY INSTALLED FROM GITHUB AS A DEPENDENCY OF THIS PACKAGE.
4546
IF THE LATEST OFFICIAL RELEASE OF FUSEPY IS USED INSTEAD, TIMESTAMPS WILL BE
4647
INACCURATE ON A NANOSECOND TO MICROSECOND SCALE AND UTIME_NOW AS WELL AS
47-
UTIME_OMIT WILL NOT BE HONORED. THERE WAS A `PULL REQUEST`_ TO FIX THIS.
48+
UTIME_OMIT WILL NOT BE HONORED. THERE WAS A `PULL REQUEST`_ TO FIX THIS,
49+
WHICH HAS BEEN REJECTED. ALTERNATIVE APPROACHES ARE BEING RESEARCHED.
4850
* THE FILESYSTEM IS CURRENTLY **ONLY** BEING DEVELOPED FOR AND TESTED ON **LINUX**.
4951
ANYONE INTERESTED IN ADDING MAC OS X AND/OR BSD SUPPORT?
5052

5153
.. _CUSTOM BUG-FIXED VERSION OF FUSEPY: https://github.com/s-m-e/fusepy
52-
.. _PENDING PULL REQUEST: https://github.com/fusepy/fusepy/pull/79
54+
.. _PULL REQUEST: https://github.com/fusepy/fusepy/pull/79
5355

5456

5557
Installation
5658
============
5759

60+
From the `Python Package Index`_ (PyPI):
61+
5862
.. code:: bash
5963
60-
pip install git+https://github.com/pleiszenburg/loggedfs-python.git@master
64+
pip install loggedfs
65+
66+
From GitHub:
6167

62-
This project has intentionally not yet been published in the `Python Package Index`_ (PyPI).
63-
It will be released on PyPI once critical changes have been merged into `fusepy`_,
64-
a dependency of LoggedFS-python.
68+
.. code:: bash
69+
70+
pip install git+https://github.com/pleiszenburg/loggedfs-python.git@master
6571
6672
**Supports Python 3.{4,5,6,7}.**
6773

6874
**Supports Linux.**
69-
Support for MAC OS X and BSD likely requires minor changes only, but has yet not been added.
75+
Support for MAC OS X and BSD requires a minor change only, but has yet not been added: Access to the system log is currently being achieved through ``logging.handlers.SysLogHandler(address = '/dev/log')``, a Linux-only solution.
7076

7177
.. _Python Package Index: https://pypi.org/
72-
.. _fusepy: https://github.com/fusepy/fusepy
7378

7479

7580
Simple usage example

0 commit comments

Comments
 (0)