Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
laurenalexander-em authored Jun 6, 2024
1 parent 9b3a898 commit 4208071
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Welcome to Numerous Files

The purpose of this package is to make a simple way to interface with both cloud, local and in-memory file storage to support a development and production workflow for web applications needing file storage. The idea is to have a common inteface where the backend can be changed without making code changes by setting env variables. In this way local development and testing can use in-memory or local file storage, eventually run tests with a cloud file storage provider and use cloud file storage in production.
The purpose of this package is to make a simple way to interface with both cloud, local, and in-memory file storage to support a development and production workflow for web applications needing file storage. The idea is to have a common inteface where the backend can be changed without making code changes by setting env variables. In this way local development and testing can use in-memory or local file storage, eventually run tests with a cloud file storage provider and use cloud file storage in production.

Simply use the factory method to get a file manager instance. You can control which file manager will be used by setting the env variable `NUMEROUS_FILES_BACKEND` to either `IN-MEMORY` to use the memory based file system, `LOCAL` to use a local folder, or `AWS_S3` to use an S3 bucket on AWS.

Expand Down

0 comments on commit 4208071

Please sign in to comment.