John Mulligan avatar John Mulligan committed a857177 Draft

add section on API stability to readme

Comments (0)

Files changed (1)

 modules.
 
 
+API Stability
+--------------
+
+I consider API stability an important part of any library. This
+becomes more and more important as a new library matures is used
+by more people. The fsnix.fslib module is the core of the library
+and maintained with the intent of keeping backwards compatibility
+in mind, however until 1.0 I do not plan on being backwards
+compatible where I think I've made a design mistake.
+The fsnix.fswlib module should follow that as it shadows the
+functionality of fslib but using ctypes. The API of the 
+fslib.util module is still immature and can fluctuate
+between versions.
+
 
 * Current Version: 0.2
 * License: MIT License
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.